From 69ce23e7711bd3cc641efed295ab4be28d460287 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 13 Sep 2022 16:14:28 +0000 Subject: [PATCH 1/5] chore: detect samples tests in nested directories (#1917) Source-Link: https://github.com/googleapis/synthtool/commit/50db768f450a50d7c1fd62513c113c9bb96fd434 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:e09366bdf0fd9c8976592988390b24d53583dd9f002d476934da43725adbb978 --- .github/.OwlBot.lock.yaml | 2 +- samples/compute/noxfile.py | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index b8dcb4a4af9..aa547962eb0 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -13,4 +13,4 @@ # limitations under the License. docker: image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest - digest: sha256:993a058718e84a82fda04c3177e58f0a43281a996c7c395e0a56ccc4d6d210d7 + digest: sha256:e09366bdf0fd9c8976592988390b24d53583dd9f002d476934da43725adbb978 diff --git a/samples/compute/noxfile.py b/samples/compute/noxfile.py index e9eb1cbfa5d..c1715136d64 100644 --- a/samples/compute/noxfile.py +++ b/samples/compute/noxfile.py @@ -207,8 +207,10 @@ def _session_tests( session: nox.sessions.Session, post_install: Callable = None ) -> None: # check for presence of tests - test_list = glob.glob("*_test.py") + glob.glob("test_*.py") - test_list.extend(glob.glob("tests")) + test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob( + "**/test_*.py", recursive=True + ) + test_list.extend(glob.glob("**/tests", recursive=True)) if len(test_list) == 0: print("No tests found, skipping directory.") From bd290b1047c6170bda2f20746a218f4e6c50513e Mon Sep 17 00:00:00 2001 From: WhiteSource Renovate Date: Thu, 15 Sep 2022 15:38:55 +0200 Subject: [PATCH 2/5] chore(deps): update dependency google-api-python-client to v2.61.0 (#1918) --- samples/compute/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/compute/requirements.txt b/samples/compute/requirements.txt index 0304f99b12b..6328b5f1472 100644 --- a/samples/compute/requirements.txt +++ b/samples/compute/requirements.txt @@ -1,3 +1,3 @@ -google-api-python-client==2.60.0 +google-api-python-client==2.61.0 google-auth==2.11.0 google-auth-httplib2==0.1.0 From 827c2f311ff7bfdbd836af91c7f009aec5bddc6e Mon Sep 17 00:00:00 2001 From: WhiteSource Renovate Date: Mon, 19 Sep 2022 21:02:10 +0200 Subject: [PATCH 3/5] chore(deps): update dependency pandas to v1.5.0 (#1920) --- scripts/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 4cdc79a8b44..01d8404d521 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1 +1 @@ -pandas==1.4.4 +pandas==1.5.0 From 4385b0db8af24676206727b2296d87bcc2decd95 Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Tue, 20 Sep 2022 00:28:36 -0700 Subject: [PATCH 4/5] chore: Update discovery artifacts (#1922) ## Deleted keys were detected in the following stable discovery artifacts: chromepolicy v1 https://github.com/googleapis/google-api-python-client/commit/a7eed1e84355a854288c0e4641c99ac9dcb936f3 dlp v2 https://github.com/googleapis/google-api-python-client/commit/34f565996691cfe1d9f7e9f591827814dbf892ef ## Deleted keys were detected in the following pre-stable discovery artifacts: analyticshub v1beta1 https://github.com/googleapis/google-api-python-client/commit/2cedffbb22a6e35606a4bfe2a53659d7eb51a29b dataflow v1b3 https://github.com/googleapis/google-api-python-client/commit/6b5939f52dcea65745f975834ef15c50c3f138bf ## Discovery Artifact Change Summary: feat(analyticshub): update the api https://github.com/googleapis/google-api-python-client/commit/2cedffbb22a6e35606a4bfe2a53659d7eb51a29b feat(artifactregistry): update the api https://github.com/googleapis/google-api-python-client/commit/24238de0ec1217ab561bc2f2b036902a0a9dfdb3 feat(assuredworkloads): update the api https://github.com/googleapis/google-api-python-client/commit/997e916d31f872f46a547dbe01a7b934d78901a5 feat(bigquery): update the api https://github.com/googleapis/google-api-python-client/commit/92ed528e52437f31f847b8707d7771fb94601f02 feat(chromemanagement): update the api https://github.com/googleapis/google-api-python-client/commit/db416b5adeeb3798d51053d15954d4a9d4b2e742 feat(chromepolicy): update the api https://github.com/googleapis/google-api-python-client/commit/a7eed1e84355a854288c0e4641c99ac9dcb936f3 feat(clouddeploy): update the api https://github.com/googleapis/google-api-python-client/commit/70bd2645b516d85169c237d820c894f7c802f392 feat(cloudsearch): update the api https://github.com/googleapis/google-api-python-client/commit/73b68e5ead37d294ba141c07242e509c32b9117b feat(container): update the api https://github.com/googleapis/google-api-python-client/commit/4fe448c2aca8c375f15a9cab6376d9ebcce24bc9 feat(dataflow): update the api https://github.com/googleapis/google-api-python-client/commit/6b5939f52dcea65745f975834ef15c50c3f138bf feat(dlp): update the api https://github.com/googleapis/google-api-python-client/commit/34f565996691cfe1d9f7e9f591827814dbf892ef feat(documentai): update the api https://github.com/googleapis/google-api-python-client/commit/29836a3a88e04b3504cea614522e931e5aa86ef7 feat(gkehub): update the api https://github.com/googleapis/google-api-python-client/commit/bf6630520fceb9690b9231f1e8fbeb03f1a6f29c feat(identitytoolkit): update the api https://github.com/googleapis/google-api-python-client/commit/9ab1181d09b6bb7164a690c362a7a1087a5b2316 feat(manufacturers): update the api https://github.com/googleapis/google-api-python-client/commit/d1c509547d0578b1703016a0da377cb220f623fe feat(securitycenter): update the api https://github.com/googleapis/google-api-python-client/commit/a92bfb1c384b7c54b4e7fc8c4b08ea09226e724b feat(spanner): update the api https://github.com/googleapis/google-api-python-client/commit/25a029df4f27696c9e13b6955deb1f5f3161fc75 feat(vmmigration): update the api https://github.com/googleapis/google-api-python-client/commit/62a1ccf9773b8de9ed9f582384d4f5182fd78104 --- ...buyer2_v2beta1.accounts.clients.users.html | 8 +- ...angebuyer2_v2beta1.accounts.creatives.html | 74 +- ...2_v2beta1.accounts.finalizedProposals.html | 44 +- ...hangebuyer2_v2beta1.accounts.products.html | 8 +- ...angebuyer2_v2beta1.accounts.proposals.html | 132 +- ...idders.accounts.filterSets.bidMetrics.html | 28 +- ...accounts.filterSets.bidResponseErrors.html | 4 +- ...ts.filterSets.bidResponsesWithoutBids.html | 4 +- ...counts.filterSets.filteredBidRequests.html | 4 +- ...nts.filterSets.filteredBids.creatives.html | 4 +- ...ounts.filterSets.filteredBids.details.html | 6 +- ...ders.accounts.filterSets.filteredBids.html | 6 +- ...2_v2beta1.bidders.accounts.filterSets.html | 72 +- ...accounts.filterSets.impressionMetrics.html | 20 +- ...idders.accounts.filterSets.losingBids.html | 6 +- ...nts.filterSets.nonBillableWinningBids.html | 4 +- ...v2beta1.bidders.filterSets.bidMetrics.html | 28 +- ....bidders.filterSets.bidResponseErrors.html | 4 +- ...rs.filterSets.bidResponsesWithoutBids.html | 4 +- ...idders.filterSets.filteredBidRequests.html | 4 +- ...ers.filterSets.filteredBids.creatives.html | 4 +- ...dders.filterSets.filteredBids.details.html | 6 +- ...beta1.bidders.filterSets.filteredBids.html | 6 +- ...angebuyer2_v2beta1.bidders.filterSets.html | 72 +- ....bidders.filterSets.impressionMetrics.html | 20 +- ...v2beta1.bidders.filterSets.losingBids.html | 6 +- ...ers.filterSets.nonBillableWinningBids.html | 4 +- docs/dyn/analyticshub_v1.html | 116 + docs/dyn/analyticshub_v1.organizations.html | 91 + ...organizations.locations.dataExchanges.html | 138 + ...alyticshub_v1.organizations.locations.html | 91 + docs/dyn/analyticshub_v1.projects.html | 91 + ...b_v1.projects.locations.dataExchanges.html | 456 + ...ects.locations.dataExchanges.listings.html | 580 + .../analyticshub_v1.projects.locations.html | 91 + ...alyticshub_v1beta1.projects.locations.html | 85 - .../androidenterprise_v1.entitlements.html | 16 +- .../androidenterprise_v1.grouplicenses.html | 8 +- ...ndroidenterprise_v1.grouplicenseusers.html | 4 +- docs/dyn/androidenterprise_v1.products.html | 16 +- docs/dyn/androidenterprise_v1.users.html | 8 +- ...oidmanagement_v1.enterprises.policies.html | 16 +- ...ay_v1.projects.locations.apis.configs.html | 6 +- ...apigateway_v1.projects.locations.apis.html | 6 +- ...ateway_v1.projects.locations.gateways.html | 6 +- ...ganizations.apis.keyvaluemaps.entries.html | 28 +- ...ons.environments.keyvaluemaps.entries.html | 28 +- ...v1.organizations.keyvaluemaps.entries.html | 28 +- ...ry_v1.projects.locations.repositories.html | 5 + ...s.locations.repositories.kfpArtifacts.html | 138 + ..._v1.organizations.locations.workloads.html | 15 + docs/dyn/assuredworkloads_v1beta1.html | 116 + ...ssuredworkloads_v1beta1.organizations.html | 91 + ...loads_v1beta1.organizations.locations.html | 96 + ...a1.organizations.locations.operations.html | 187 + ...ta1.organizations.locations.workloads.html | 612 + ...ons.locations.workloads.organizations.html | 91 + ...ons.workloads.organizations.locations.html | 91 + ...ads.organizations.locations.workloads.html | 112 + ...ations.locations.workloads.violations.html | 175 + .../assuredworkloads_v1beta1.projects.html | 91 + ...kloads_v1beta1.projects.organizations.html | 91 + ...eta1.projects.organizations.locations.html | 91 + ...cts.organizations.locations.workloads.html | 112 + ..._v1.projects.locations.appConnections.html | 6 +- ...p_v1.projects.locations.appConnectors.html | 6 +- ...orp_v1.projects.locations.appGateways.html | 6 +- ...cts.locations.clientConnectorServices.html | 6 +- ..._v1.projects.locations.clientGateways.html | 6 +- docs/dyn/bigquery_v2.jobs.html | 15 + ...2.projects.instances.clusters.backups.html | 6 +- .../bigtableadmin_v2.projects.instances.html | 6 +- ...bleadmin_v2.projects.instances.tables.html | 6 +- ...chromemanagement_v1.customers.reports.html | 47 + .../cloudbilling_v1beta.billingAccounts.html | 447 + docs/dyn/cloudbilling_v1beta.html | 116 + docs/dyn/cloudbilling_v1beta.v1beta.html | 446 + ....projects.locations.deliveryPipelines.html | 20 + ....locations.deliveryPipelines.releases.html | 21 +- ...s.deliveryPipelines.releases.rollouts.html | 118 +- ...ryPipelines.releases.rollouts.jobRuns.html | 199 + ...ddeploy_v1.projects.locations.targets.html | 8 +- .../dyn/cloudresourcemanager_v3.projects.html | 4 +- docs/dyn/cloudsupport_v2beta.cases.html | 2 +- ...beta2.projects.locations.queues.tasks.html | 11 +- ...ors_v1.projects.locations.connections.html | 6 +- ...ctors_v1.projects.locations.providers.html | 6 +- ...tainer_v1.projects.locations.clusters.html | 20 +- ...projects.locations.clusters.nodePools.html | 6 +- .../container_v1.projects.zones.clusters.html | 20 +- ..._v1.projects.zones.clusters.nodePools.html | 6 +- ...r_v1beta1.projects.locations.clusters.html | 32 +- ...projects.locations.clusters.nodePools.html | 12 +- ...ainer_v1beta1.projects.zones.clusters.html | 32 +- ...ta1.projects.zones.clusters.nodePools.html | 12 +- docs/dyn/dataflow_v1b3.projects.jobs.html | 17 +- ...v1b3.projects.locations.flexTemplates.html | 1 - ...dataflow_v1b3.projects.locations.jobs.html | 11 +- ...low_v1b3.projects.locations.templates.html | 2 - .../dyn/dataflow_v1b3.projects.templates.html | 2 - docs/dyn/datastore_v1.projects.html | 296 +- docs/dyn/datastore_v1beta3.projects.html | 286 +- .../deploymentmanager_alpha.deployments.html | 8 +- .../dyn/deploymentmanager_v2.deployments.html | 8 +- .../deploymentmanager_v2beta.deployments.html | 8 +- .../displayvideo_v2.advertisers.assets.html | 120 + ...displayvideo_v2.advertisers.campaigns.html | 986 + ...rgetingTypes.assignedTargetingOptions.html | 825 + ....advertisers.campaigns.targetingTypes.html | 91 + .../displayvideo_v2.advertisers.channels.html | 262 + ...ayvideo_v2.advertisers.channels.sites.html | 281 + ...displayvideo_v2.advertisers.creatives.html | 1127 + docs/dyn/displayvideo_v2.advertisers.html | 1561 ++ ...yvideo_v2.advertisers.insertionOrders.html | 1064 + ...rgetingTypes.assignedTargetingOptions.html | 825 + ...tisers.insertionOrders.targetingTypes.html | 91 + .../displayvideo_v2.advertisers.invoices.html | 213 + ...displayvideo_v2.advertisers.lineItems.html | 2206 ++ ...rgetingTypes.assignedTargetingOptions.html | 1544 ++ ....advertisers.lineItems.targetingTypes.html | 91 + ...isers.locationLists.assignedLocations.html | 239 + ...layvideo_v2.advertisers.locationLists.html | 246 + ...ayvideo_v2.advertisers.manualTriggers.html | 323 + ...o_v2.advertisers.negativeKeywordLists.html | 266 + ...negativeKeywordLists.negativeKeywords.html | 274 + ...rgetingTypes.assignedTargetingOptions.html | 1540 ++ ...ayvideo_v2.advertisers.targetingTypes.html | 91 + .../displayvideo_v2.combinedAudiences.html | 163 + ...splayvideo_v2.customBiddingAlgorithms.html | 342 + ...eo_v2.customBiddingAlgorithms.scripts.html | 255 + docs/dyn/displayvideo_v2.customLists.html | 161 + ...yvideo_v2.firstAndThirdPartyAudiences.html | 499 + .../dyn/displayvideo_v2.floodlightGroups.html | 191 + docs/dyn/displayvideo_v2.googleAudiences.html | 165 + .../dyn/displayvideo_v2.guaranteedOrders.html | 374 + docs/dyn/displayvideo_v2.html | 181 + ...SourceGroups.assignedInventorySources.html | 243 + ...displayvideo_v2.inventorySourceGroups.html | 261 + .../dyn/displayvideo_v2.inventorySources.html | 667 + docs/dyn/displayvideo_v2.media.html | 159 + .../displayvideo_v2.partners.channels.html | 262 + ...splayvideo_v2.partners.channels.sites.html | 281 + docs/dyn/displayvideo_v2.partners.html | 845 + ...rgetingTypes.assignedTargetingOptions.html | 1540 ++ ...splayvideo_v2.partners.targetingTypes.html | 91 + .../dyn/displayvideo_v2.sdfdownloadtasks.html | 171 + ...yvideo_v2.sdfdownloadtasks.operations.html | 124 + docs/dyn/displayvideo_v2.targetingTypes.html | 91 + ...eo_v2.targetingTypes.targetingOptions.html | 684 + docs/dyn/displayvideo_v2.users.html | 346 + ...ntai_v1.projects.locations.processors.html | 2 + ...ocations.processors.humanReviewConfig.html | 1 + ...ocations.processors.processorVersions.html | 2 + ...documentai_v1beta2.projects.documents.html | 1 + ..._v1beta2.projects.locations.documents.html | 1 + ...v1beta3.projects.locations.processors.html | 3 + ...ocations.processors.humanReviewConfig.html | 2 + ...ocations.processors.processorVersions.html | 3 + ...store_v1.projects.databases.documents.html | 516 +- ...gkehub_v1.projects.locations.features.html | 48 + ...b_v1alpha.projects.locations.features.html | 12 + ...1alpha.projects.locations.memberships.html | 107 + ...ub_v1beta.projects.locations.features.html | 48 + .../identitytoolkit_v2.projects.tenants.html | 30 + docs/dyn/index.md | 8 + docs/dyn/integrations_v1alpha.callback.html | 117 + ...ions_v1alpha.connectorPlatformRegions.html | 109 + docs/dyn/integrations_v1alpha.html | 121 + docs/dyn/integrations_v1alpha.projects.html | 91 + ...projects.locations.appsScriptProjects.html | 145 + ...1alpha.projects.locations.authConfigs.html | 2420 ++ ...alpha.projects.locations.certificates.html | 120 + ...1alpha.projects.locations.connections.html | 268 + ...ions.connections.runtimeActionSchemas.html | 135 + ...ions.connections.runtimeEntitySchemas.html | 135 + ...tegrations_v1alpha.projects.locations.html | 287 + ...cts.locations.integrations.executions.html | 783 + ...alpha.projects.locations.integrations.html | 678 + ...jects.locations.integrations.versions.html | 6369 ++++++ ...ojects.locations.products.authConfigs.html | 2420 ++ ...jects.locations.products.certificates.html | 308 + ...s_v1alpha.projects.locations.products.html | 316 + ...ions.products.integrations.executions.html | 1197 + ...s.integrations.executions.suspensions.html | 441 + ...ducts.integrations.executionsnapshots.html | 256 + ...jects.locations.products.integrations.html | 710 + ...ations.products.integrations.versions.html | 7353 ++++++ ...cations.products.integrationtemplates.html | 91 + ...roducts.integrationtemplates.versions.html | 3036 +++ ...ects.locations.products.sfdcInstances.html | 301 + ...s.products.sfdcInstances.sfdcChannels.html | 284 + ...lpha.projects.locations.sfdcInstances.html | 301 + ....locations.sfdcInstances.sfdcChannels.html | 284 + .../manufacturers_v1.accounts.products.html | 150 +- docs/dyn/mybusinesslodging_v1.locations.html | 12 +- ...ybusinesslodging_v1.locations.lodging.html | 4 +- ...ty_v1.projects.locations.global_.hubs.html | 6 +- ...s.locations.global_.policyBasedRoutes.html | 6 +- ...ectivity_v1.projects.locations.spokes.html | 6 +- ...s.locations.global_.connectivityTests.html | 78 +- ...s.locations.global_.connectivityTests.html | 78 +- ...llersubscription_v1.partners.products.html | 2 +- docs/dyn/pubsub_v1.projects.snapshots.html | 4 +- .../dyn/pubsub_v1.projects.subscriptions.html | 38 +- .../realtimebidding_v1.bidders.creatives.html | 48 +- docs/dyn/realtimebidding_v1.bidders.html | 4 +- ...dding_v1.bidders.publisherConnections.html | 2 +- .../realtimebidding_v1.buyers.creatives.html | 256 +- docs/dyn/realtimebidding_v1.buyers.html | 4 +- .../dyn/run_v1.namespaces.configurations.html | 4 +- docs/dyn/run_v1.namespaces.executions.html | 6 +- docs/dyn/run_v1.namespaces.jobs.html | 14 +- docs/dyn/run_v1.namespaces.revisions.html | 4 +- docs/dyn/run_v1.namespaces.services.html | 12 +- docs/dyn/run_v1.namespaces.tasks.html | 4 +- ..._v1.projects.locations.configurations.html | 4 +- .../run_v1.projects.locations.revisions.html | 4 +- .../run_v1.projects.locations.services.html | 12 +- ...itycenter_v1.folders.sources.findings.html | 15 +- ...ter_v1.organizations.sources.findings.html | 21 +- ...tycenter_v1.projects.sources.findings.html | 15 +- ...servicemanagement_v1.services.configs.html | 24 +- docs/dyn/servicemanagement_v1.services.html | 6 +- docs/dyn/slides_v1.presentations.html | 1093 +- docs/dyn/slides_v1.presentations.pages.html | 7 +- docs/dyn/spanner_v1.projects.html | 5 + ..._v1.projects.instanceConfigOperations.html | 149 + .../spanner_v1.projects.instanceConfigs.html | 205 + ...1.projects.instances.backupOperations.html | 2 +- ...spanner_v1.projects.instances.backups.html | 6 +- ...anner_v1.projects.instances.databases.html | 6 +- ...projects.instances.databases.sessions.html | 16 + docs/dyn/spanner_v1.projects.instances.html | 6 +- ...rations.projects.locations.operations.html | 4 +- ...ence_v1.projects.locations.operations.html | 4 +- ...ojects.locations.sources.migratingVms.html | 5 + ...ions.sources.migratingVms.cutoverJobs.html | 66 + ...ojects.locations.sources.migratingVms.html | 137 + ...ources.migratingVms.replicationCycles.html | 22 + .../acceleratedmobilepageurl.v1.json | 2 +- .../documents/accesscontextmanager.v1.json | 2 +- .../accesscontextmanager.v1beta.json | 2 +- .../documents/adexchangebuyer2.v2beta1.json | 74 +- .../documents/admin.datatransfer_v1.json | 2 +- .../documents/admin.directory_v1.json | 4 +- .../documents/admin.reports_v1.json | 2 +- .../discovery_cache/documents/admob.v1.json | 2 +- .../documents/admob.v1beta.json | 2 +- .../discovery_cache/documents/adsense.v2.json | 2 +- .../documents/alertcenter.v1beta1.json | 2 +- .../documents/analyticsadmin.v1alpha.json | 2 +- .../documents/analyticsdata.v1beta.json | 2 +- .../documents/analyticshub.v1.json | 1256 + .../documents/analyticshub.v1beta1.json | 124 +- .../androiddeviceprovisioning.v1.json | 2 +- .../documents/androidenterprise.v1.json | 28 +- .../documents/androidmanagement.v1.json | 6 +- .../documents/androidpublisher.v3.json | 2 +- .../documents/apigateway.v1.json | 4 +- .../discovery_cache/documents/apigee.v1.json | 30 +- .../documents/apigeeregistry.v1.json | 2 +- .../discovery_cache/documents/apikeys.v2.json | 2 +- .../documents/appengine.v1.json | 2 +- .../documents/appengine.v1alpha.json | 2 +- .../documents/appengine.v1beta.json | 2 +- .../documents/area120tables.v1alpha1.json | 2 +- .../documents/artifactregistry.v1.json | 97 +- .../documents/artifactregistry.v1beta1.json | 2 +- .../documents/artifactregistry.v1beta2.json | 2 +- .../documents/assuredworkloads.v1.json | 46 +- .../documents/assuredworkloads.v1beta1.json | 2175 ++ .../authorizedbuyersmarketplace.v1.json | 2 +- .../documents/beyondcorp.v1.json | 4 +- .../documents/bigquery.v2.json | 17 +- .../documents/bigqueryconnection.v1beta1.json | 2 +- .../documents/bigquerydatatransfer.v1.json | 2 +- .../documents/bigqueryreservation.v1.json | 2 +- .../bigqueryreservation.v1beta1.json | 2 +- .../documents/bigtableadmin.v2.json | 4 +- .../documents/binaryauthorization.v1.json | 2 +- .../binaryauthorization.v1beta1.json | 2 +- .../discovery_cache/documents/blogger.v2.json | 2 +- .../discovery_cache/documents/blogger.v3.json | 2 +- .../discovery_cache/documents/books.v1.json | 2 +- .../businessprofileperformance.v1.json | 2 +- .../documents/certificatemanager.v1.json | 2 +- .../discovery_cache/documents/chat.v1.json | 4 +- .../documents/chromemanagement.v1.json | 89 +- .../documents/chromepolicy.v1.json | 14 +- .../documents/chromeuxreport.v1.json | 2 +- .../documents/civicinfo.v2.json | 2 +- .../documents/classroom.v1.json | 2 +- .../documents/cloudbilling.v1.json | 2 +- .../documents/cloudbilling.v1beta.json | 871 + .../documents/cloudbuild.v1.json | 2 +- .../documents/cloudbuild.v1alpha1.json | 2 +- .../documents/cloudbuild.v1alpha2.json | 2 +- .../documents/cloudbuild.v1beta1.json | 2 +- .../documents/cloudchannel.v1.json | 2 +- .../documents/clouddebugger.v2.json | 2 +- .../documents/clouddeploy.v1.json | 478 +- .../documents/cloudidentity.v1.json | 2 +- .../documents/cloudidentity.v1beta1.json | 2 +- .../documents/cloudkms.v1.json | 2 +- .../documents/cloudprofiler.v2.json | 2 +- .../documents/cloudresourcemanager.v1.json | 2 +- .../cloudresourcemanager.v1beta1.json | 2 +- .../documents/cloudresourcemanager.v2.json | 2 +- .../cloudresourcemanager.v2beta1.json | 2 +- .../documents/cloudresourcemanager.v3.json | 4 +- .../documents/cloudsearch.v1.json | 27 +- .../documents/cloudshell.v1.json | 2 +- .../documents/cloudsupport.v2beta.json | 4 +- .../documents/composer.v1.json | 2 +- .../documents/composer.v1beta1.json | 2 +- .../documents/connectors.v1.json | 4 +- .../documents/connectors.v2.json | 2 +- .../documents/container.v1.json | 54 +- .../documents/container.v1beta1.json | 56 +- .../documents/content.v2.1.json | 2 +- .../documents/customsearch.v1.json | 2 +- .../documents/dataflow.v1b3.json | 21 +- .../documents/datalabeling.v1beta1.json | 2 +- .../documents/datapipelines.v1.json | 2 +- .../documents/dataproc.v1.json | 2 +- .../documents/datastream.v1.json | 2 +- .../documents/deploymentmanager.alpha.json | 4 +- .../documents/deploymentmanager.v2.json | 4 +- .../documents/deploymentmanager.v2beta.json | 4 +- .../documents/digitalassetlinks.v1.json | 2 +- .../documents/displayvideo.v1.json | 2 +- .../documents/displayvideo.v2.json | 19069 ++++++++++++++++ .../discovery_cache/documents/dlp.v2.json | 9 +- .../discovery_cache/documents/docs.v1.json | 2 +- .../documents/documentai.v1.json | 14 +- .../documents/documentai.v1beta2.json | 10 +- .../documents/documentai.v1beta3.json | 14 +- .../documents/domainsrdap.v1.json | 2 +- .../documents/doubleclickbidmanager.v1.1.json | 2 +- .../documents/doubleclickbidmanager.v2.json | 2 +- .../documents/doubleclicksearch.v2.json | 2 +- .../discovery_cache/documents/drive.v2.json | 4 +- .../discovery_cache/documents/drive.v3.json | 4 +- .../documents/driveactivity.v2.json | 2 +- .../documents/drivelabels.v2.json | 2 +- .../documents/drivelabels.v2beta.json | 2 +- .../documents/essentialcontacts.v1.json | 2 +- .../documents/eventarc.v1beta1.json | 2 +- .../documents/factchecktools.v1alpha1.json | 2 +- .../discovery_cache/documents/fcm.v1.json | 2 +- .../documents/fcmdata.v1beta1.json | 2 +- .../documents/firebase.v1beta1.json | 2 +- .../documents/firebaseappcheck.v1.json | 2 +- .../documents/firebaseappcheck.v1beta.json | 2 +- .../documents/firebasedatabase.v1beta.json | 2 +- .../documents/firebasedynamiclinks.v1.json | 2 +- .../documents/firebasehosting.v1.json | 2 +- .../documents/firebasehosting.v1beta1.json | 2 +- .../documents/firebaseml.v1.json | 2 +- .../documents/firebaseml.v1beta2.json | 2 +- .../documents/firebaserules.v1.json | 2 +- .../discovery_cache/documents/fitness.v1.json | 2 +- .../discovery_cache/documents/forms.v1.json | 2 +- .../discovery_cache/documents/games.v1.json | 2 +- .../gamesConfiguration.v1configuration.json | 2 +- .../gamesManagement.v1management.json | 2 +- .../documents/gameservices.v1beta.json | 2 +- .../documents/genomics.v2alpha1.json | 4 +- .../discovery_cache/documents/gkehub.v1.json | 63 +- .../documents/gkehub.v1alpha.json | 106 +- .../documents/gkehub.v1alpha2.json | 2 +- .../documents/gkehub.v1beta.json | 63 +- .../documents/gkehub.v1beta1.json | 2 +- .../documents/gkehub.v2alpha.json | 2 +- .../documents/gmailpostmastertools.v1.json | 2 +- .../gmailpostmastertools.v1beta1.json | 2 +- .../documents/groupsmigration.v1.json | 2 +- .../documents/homegraph.v1.json | 2 +- .../discovery_cache/documents/iam.v1.json | 2 +- .../discovery_cache/documents/iam.v2beta.json | 2 +- .../documents/iamcredentials.v1.json | 2 +- .../discovery_cache/documents/iap.v1.json | 2 +- .../documents/iap.v1beta1.json | 2 +- .../documents/ideahub.v1alpha.json | 2 +- .../documents/ideahub.v1beta.json | 2 +- .../documents/identitytoolkit.v1.json | 2 +- .../documents/identitytoolkit.v2.json | 6 +- .../discovery_cache/documents/ids.v1.json | 2 +- .../documents/indexing.v3.json | 2 +- .../documents/integrations.v1alpha.json | 11238 +++++++++ .../discovery_cache/documents/jobs.v3.json | 2 +- .../documents/jobs.v3p1beta1.json | 2 +- .../discovery_cache/documents/jobs.v4.json | 2 +- .../discovery_cache/documents/keep.v1.json | 2 +- .../documents/libraryagent.v1.json | 2 +- .../documents/licensing.v1.json | 2 +- .../documents/localservices.v1.json | 2 +- .../discovery_cache/documents/logging.v2.json | 2 +- .../documents/manufacturers.v1.json | 9 +- .../documents/memcache.v1.json | 2 +- .../documents/memcache.v1beta2.json | 2 +- .../documents/metastore.v1alpha.json | 2 +- .../documents/metastore.v1beta.json | 2 +- .../documents/monitoring.v1.json | 2 +- .../documents/monitoring.v3.json | 2 +- .../mybusinessaccountmanagement.v1.json | 2 +- .../documents/mybusinessbusinesscalls.v1.json | 2 +- .../mybusinessbusinessinformation.v1.json | 2 +- .../documents/mybusinesslodging.v1.json | 6 +- .../documents/mybusinessnotifications.v1.json | 2 +- .../documents/mybusinessplaceactions.v1.json | 2 +- .../documents/mybusinessqanda.v1.json | 2 +- .../documents/mybusinessverifications.v1.json | 2 +- .../documents/networkconnectivity.v1.json | 4 +- .../documents/networkmanagement.v1.json | 54 +- .../documents/networkmanagement.v1beta1.json | 64 +- .../documents/networksecurity.v1.json | 2 +- .../documents/networksecurity.v1beta1.json | 2 +- .../documents/networkservices.v1.json | 2 +- .../documents/networkservices.v1beta1.json | 2 +- .../documents/notebooks.v1.json | 2 +- .../documents/ondemandscanning.v1.json | 2 +- .../documents/ondemandscanning.v1beta1.json | 2 +- .../documents/orgpolicy.v2.json | 2 +- .../documents/osconfig.v1.json | 2 +- .../documents/osconfig.v1alpha.json | 2 +- .../documents/osconfig.v1beta.json | 2 +- .../documents/pagespeedonline.v5.json | 2 +- .../paymentsresellersubscription.v1.json | 4 +- .../discovery_cache/documents/people.v1.json | 2 +- .../documents/playcustomapp.v1.json | 2 +- .../playdeveloperreporting.v1alpha1.json | 2 +- .../playdeveloperreporting.v1beta1.json | 2 +- .../documents/playintegrity.v1.json | 2 +- .../documents/policyanalyzer.v1.json | 2 +- .../documents/policyanalyzer.v1beta1.json | 2 +- .../documents/policysimulator.v1.json | 2 +- .../documents/policysimulator.v1alpha.json | 2 +- .../documents/policysimulator.v1beta1.json | 2 +- .../documents/privateca.v1beta1.json | 2 +- .../documents/prod_tt_sasportal.v1alpha1.json | 2 +- .../discovery_cache/documents/pubsub.v1.json | 12 +- .../documents/pubsub.v1beta1a.json | 2 +- .../documents/pubsub.v1beta2.json | 2 +- .../documents/pubsublite.v1.json | 2 +- .../documents/realtimebidding.v1.json | 34 +- .../documents/realtimebidding.v1alpha.json | 6 +- .../documents/recaptchaenterprise.v1.json | 2 +- .../recommendationengine.v1beta1.json | 2 +- .../documents/recommender.v1.json | 2 +- .../documents/recommender.v1beta1.json | 2 +- .../discovery_cache/documents/redis.v1.json | 2 +- .../documents/redis.v1beta1.json | 2 +- .../documents/reseller.v1.json | 2 +- .../documents/resourcesettings.v1.json | 2 +- .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/run.v2.json | 2 +- .../documents/runtimeconfig.v1.json | 2 +- .../documents/runtimeconfig.v1beta1.json | 2 +- .../documents/safebrowsing.v4.json | 2 +- .../discovery_cache/documents/script.v1.json | 2 +- .../documents/searchconsole.v1.json | 2 +- .../documents/secretmanager.v1.json | 2 +- .../documents/secretmanager.v1beta1.json | 2 +- .../documents/securitycenter.v1.json | 45 +- .../documents/securitycenter.v1beta1.json | 45 +- .../documents/securitycenter.v1beta2.json | 45 +- .../serviceconsumermanagement.v1.json | 2 +- .../serviceconsumermanagement.v1beta1.json | 2 +- .../documents/servicecontrol.v1.json | 2 +- .../documents/servicecontrol.v2.json | 2 +- .../documents/servicedirectory.v1.json | 2 +- .../documents/servicedirectory.v1beta1.json | 2 +- .../documents/servicemanagement.v1.json | 8 +- .../documents/servicenetworking.v1.json | 2 +- .../documents/servicenetworking.v1beta.json | 2 +- .../documents/serviceusage.v1.json | 2 +- .../documents/serviceusage.v1beta1.json | 2 +- .../discovery_cache/documents/sheets.v4.json | 2 +- .../discovery_cache/documents/slides.v1.json | 2 +- .../documents/smartdevicemanagement.v1.json | 2 +- .../documents/sourcerepo.v1.json | 2 +- .../discovery_cache/documents/spanner.v1.json | 324 +- .../discovery_cache/documents/speech.v1.json | 2 +- .../documents/speech.v1p1beta1.json | 2 +- .../discovery_cache/documents/storage.v1.json | 4 +- .../documents/storagetransfer.v1.json | 2 +- .../documents/streetviewpublish.v1.json | 2 +- .../discovery_cache/documents/sts.v1.json | 2 +- .../discovery_cache/documents/sts.v1beta.json | 2 +- .../documents/tagmanager.v1.json | 2 +- .../documents/tagmanager.v2.json | 2 +- .../discovery_cache/documents/tasks.v1.json | 2 +- .../discovery_cache/documents/testing.v1.json | 2 +- .../documents/texttospeech.v1.json | 2 +- .../documents/texttospeech.v1beta1.json | 2 +- .../documents/toolresults.v1beta3.json | 2 +- .../documents/trafficdirector.v2.json | 2 +- .../documents/transcoder.v1.json | 2 +- .../discovery_cache/documents/vault.v1.json | 2 +- .../documents/versionhistory.v1.json | 2 +- .../documents/videointelligence.v1.json | 4 +- .../documents/videointelligence.v1beta2.json | 2 +- .../videointelligence.v1p1beta1.json | 2 +- .../videointelligence.v1p2beta1.json | 2 +- .../videointelligence.v1p3beta1.json | 2 +- .../documents/vmmigration.v1.json | 107 +- .../documents/vmmigration.v1alpha1.json | 134 +- .../discovery_cache/documents/webrisk.v1.json | 2 +- .../documents/workflowexecutions.v1.json | 2 +- .../documents/workflowexecutions.v1beta.json | 2 +- .../documents/workflows.v1.json | 2 +- .../documents/workflows.v1beta.json | 2 +- .../discovery_cache/documents/youtube.v3.json | 2 +- .../documents/youtubeAnalytics.v2.json | 2 +- .../documents/youtubereporting.v1.json | 2 +- 516 files changed, 95742 insertions(+), 3410 deletions(-) create mode 100644 docs/dyn/analyticshub_v1.html create mode 100644 docs/dyn/analyticshub_v1.organizations.html create mode 100644 docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html create mode 100644 docs/dyn/analyticshub_v1.organizations.locations.html create mode 100644 docs/dyn/analyticshub_v1.projects.html create mode 100644 docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html create mode 100644 docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html create mode 100644 docs/dyn/analyticshub_v1.projects.locations.html create mode 100644 docs/dyn/artifactregistry_v1.projects.locations.repositories.kfpArtifacts.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.operations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.workloads.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.organizations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.html create mode 100644 docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.workloads.html create mode 100644 docs/dyn/cloudbilling_v1beta.billingAccounts.html create mode 100644 docs/dyn/cloudbilling_v1beta.html create mode 100644 docs/dyn/cloudbilling_v1beta.v1beta.html create mode 100644 docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.assets.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.campaigns.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.channels.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.channels.sites.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.creatives.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.insertionOrders.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.invoices.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.lineItems.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.locationLists.assignedLocations.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.locationLists.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.manualTriggers.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.negativeKeywordLists.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.negativeKeywordLists.negativeKeywords.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v2.advertisers.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v2.combinedAudiences.html create mode 100644 docs/dyn/displayvideo_v2.customBiddingAlgorithms.html create mode 100644 docs/dyn/displayvideo_v2.customBiddingAlgorithms.scripts.html create mode 100644 docs/dyn/displayvideo_v2.customLists.html create mode 100644 docs/dyn/displayvideo_v2.firstAndThirdPartyAudiences.html create mode 100644 docs/dyn/displayvideo_v2.floodlightGroups.html create mode 100644 docs/dyn/displayvideo_v2.googleAudiences.html create mode 100644 docs/dyn/displayvideo_v2.guaranteedOrders.html create mode 100644 docs/dyn/displayvideo_v2.html create mode 100644 docs/dyn/displayvideo_v2.inventorySourceGroups.assignedInventorySources.html create mode 100644 docs/dyn/displayvideo_v2.inventorySourceGroups.html create mode 100644 docs/dyn/displayvideo_v2.inventorySources.html create mode 100644 docs/dyn/displayvideo_v2.media.html create mode 100644 docs/dyn/displayvideo_v2.partners.channels.html create mode 100644 docs/dyn/displayvideo_v2.partners.channels.sites.html create mode 100644 docs/dyn/displayvideo_v2.partners.html create mode 100644 docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html create mode 100644 docs/dyn/displayvideo_v2.partners.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v2.sdfdownloadtasks.html create mode 100644 docs/dyn/displayvideo_v2.sdfdownloadtasks.operations.html create mode 100644 docs/dyn/displayvideo_v2.targetingTypes.html create mode 100644 docs/dyn/displayvideo_v2.targetingTypes.targetingOptions.html create mode 100644 docs/dyn/displayvideo_v2.users.html create mode 100644 docs/dyn/integrations_v1alpha.callback.html create mode 100644 docs/dyn/integrations_v1alpha.connectorPlatformRegions.html create mode 100644 docs/dyn/integrations_v1alpha.html create mode 100644 docs/dyn/integrations_v1alpha.projects.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.appsScriptProjects.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.certificates.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.connections.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.connections.runtimeActionSchemas.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.connections.runtimeEntitySchemas.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.integrations.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.certificates.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executionsnapshots.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.sfdcInstances.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.products.sfdcInstances.sfdcChannels.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.html create mode 100644 docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.sfdcChannels.html create mode 100644 docs/dyn/spanner_v1.projects.instanceConfigOperations.html create mode 100644 googleapiclient/discovery_cache/documents/analyticshub.v1.json create mode 100644 googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json create mode 100644 googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json create mode 100644 googleapiclient/discovery_cache/documents/displayvideo.v2.json create mode 100644 googleapiclient/discovery_cache/documents/integrations.v1alpha.json diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.users.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.users.html index 48859b6215c..db9aa7f85e2 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.users.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.users.html @@ -111,7 +111,7 @@

Method Details

Returns: An object of the form: - { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. + { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. "email": "A String", # User's email address. The value of this field is ignored in an update operation. "status": "A String", # The status of the client user. @@ -139,7 +139,7 @@

Method Details

{ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results. "users": [ # The returned list of client users. - { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. + { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. "email": "A String", # User's email address. The value of this field is ignored in an update operation. "status": "A String", # The status of the client user. @@ -174,7 +174,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. +{ # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. "email": "A String", # User's email address. The value of this field is ignored in an update operation. "status": "A String", # The status of the client user. @@ -189,7 +189,7 @@

Method Details

Returns: An object of the form: - { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. + { # A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. "clientAccountId": "A String", # Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. "email": "A String", # User's email address. The value of this field is ignored in an update operation. "status": "A String", # The status of the client user. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html index a6a57892342..46b1a5f8b1a 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html @@ -129,7 +129,7 @@

Method Details

}, "advertiserName": "A String", # The name of the company being advertised in the creative. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. "A String", ], @@ -152,7 +152,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -233,8 +233,8 @@

Method Details

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. "A String", ], - "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). - { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). + "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction). + { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction). "contexts": [ # The contexts for the restriction. { # The serving context for this restriction. "all": "A String", # Matches all contexts. @@ -249,7 +249,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -271,7 +271,7 @@

Method Details

], "reason": "A String", # The categorized reason for disapproval. }, - "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. + "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead. { # Output only. The reason and details for a disapproval. "details": [ # Additional details about the reason for disapproval. "A String", @@ -315,7 +315,7 @@

Method Details

}, "advertiserName": "A String", # The name of the company being advertised in the creative. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. "A String", ], @@ -338,7 +338,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -419,8 +419,8 @@

Method Details

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. "A String", ], - "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). - { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). + "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction). + { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction). "contexts": [ # The contexts for the restriction. { # The serving context for this restriction. "all": "A String", # Matches all contexts. @@ -435,7 +435,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -457,7 +457,7 @@

Method Details

], "reason": "A String", # The categorized reason for disapproval. }, - "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. + "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead. { # Output only. The reason and details for a disapproval. "details": [ # Additional details about the reason for disapproval. "A String", @@ -505,7 +505,7 @@

Method Details

}, "advertiserName": "A String", # The name of the company being advertised in the creative. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. "A String", ], @@ -528,7 +528,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -609,8 +609,8 @@

Method Details

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. "A String", ], - "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). - { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). + "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction). + { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction). "contexts": [ # The contexts for the restriction. { # The serving context for this restriction. "all": "A String", # Matches all contexts. @@ -625,7 +625,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -647,7 +647,7 @@

Method Details

], "reason": "A String", # The categorized reason for disapproval. }, - "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. + "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead. { # Output only. The reason and details for a disapproval. "details": [ # Additional details about the reason for disapproval. "A String", @@ -675,7 +675,7 @@

Method Details

Args: accountId: string, The account to list the creatives from. Specify "-" to list all creatives the current user has access to. (required) - pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. + pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method. query: string, An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' x__xgafv: string, V1 error format. @@ -699,7 +699,7 @@

Method Details

}, "advertiserName": "A String", # The name of the company being advertised in the creative. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. "A String", ], @@ -722,7 +722,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -803,8 +803,8 @@

Method Details

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. "A String", ], - "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). - { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). + "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction). + { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction). "contexts": [ # The contexts for the restriction. { # The serving context for this restriction. "all": "A String", # Matches all contexts. @@ -819,7 +819,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -841,7 +841,7 @@

Method Details

], "reason": "A String", # The categorized reason for disapproval. }, - "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. + "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead. { # Output only. The reason and details for a disapproval. "details": [ # Additional details about the reason for disapproval. "A String", @@ -926,7 +926,7 @@

Method Details

}, "advertiserName": "A String", # The name of the company being advertised in the creative. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. "A String", ], @@ -949,7 +949,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -1030,8 +1030,8 @@

Method Details

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. "A String", ], - "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). - { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). + "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction). + { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction). "contexts": [ # The contexts for the restriction. { # The serving context for this restriction. "all": "A String", # Matches all contexts. @@ -1046,7 +1046,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -1068,7 +1068,7 @@

Method Details

], "reason": "A String", # The categorized reason for disapproval. }, - "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. + "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead. { # Output only. The reason and details for a disapproval. "details": [ # Additional details about the reason for disapproval. "A String", @@ -1108,7 +1108,7 @@

Method Details

}, "advertiserName": "A String", # The name of the company being advertised in the creative. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. "A String", ], @@ -1131,7 +1131,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -1212,8 +1212,8 @@

Method Details

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. "A String", ], - "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). - { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). + "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction). + { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction). "contexts": [ # The contexts for the restriction. { # The serving context for this restriction. "all": "A String", # Matches all contexts. @@ -1228,7 +1228,7 @@

Method Details

], }, "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. - "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. + "geoCriteriaIds": [ # IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 42, ], }, @@ -1250,7 +1250,7 @@

Method Details

], "reason": "A String", # The categorized reason for disapproval. }, - "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. + "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead. { # Output only. The reason and details for a disapproval. "details": [ # Additional details about the reason for disapproval. "A String", diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.finalizedProposals.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.finalizedProposals.html index 5db6a70e606..7554ac2b24c 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.finalizedProposals.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.finalizedProposals.html @@ -85,10 +85,10 @@

Instance Methods

Retrieves the next page of results.

pause(accountId, proposalId, body=None, x__xgafv=None)

-

Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

+

Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

resume(accountId, proposalId, body=None, x__xgafv=None)

-

Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

+

Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

Method Details

close() @@ -139,7 +139,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -147,7 +147,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -178,7 +178,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -308,7 +308,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -319,7 +319,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -328,7 +328,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -521,7 +521,7 @@

Method Details

pause(accountId, proposalId, body=None, x__xgafv=None) -
Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
+  
Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
 
 Args:
   accountId: string, Account ID of the buyer. (required)
@@ -563,7 +563,7 @@ 

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -571,7 +571,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -602,7 +602,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -732,7 +732,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -743,7 +743,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -752,7 +752,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -929,7 +929,7 @@

Method Details

resume(accountId, proposalId, body=None, x__xgafv=None) -
Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
+  
Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
 
 Args:
   accountId: string, Account ID of the buyer. (required)
@@ -970,7 +970,7 @@ 

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -978,7 +978,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -1009,7 +1009,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -1139,7 +1139,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -1150,7 +1150,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -1159,7 +1159,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.products.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.products.html index 64c7369482d..a042f123543 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.products.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.products.html @@ -107,7 +107,7 @@

Method Details

Returns: An object of the form: - { # A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. + { # A product is a segment of inventory that a seller wants to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. "availableEndTime": "A String", # The proposed end time for the deal. The field will be truncated to the order of seconds during serving. "availableStartTime": "A String", # Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving. "createTime": "A String", # Creation time. @@ -220,7 +220,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. }, ], - "terms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "terms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -326,7 +326,7 @@

Method Details

{ # Response message for listing products visible to the buyer. "nextPageToken": "A String", # List pagination support. "products": [ # The list of matching products at their head revision number. - { # A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. + { # A product is a segment of inventory that a seller wants to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. "availableEndTime": "A String", # The proposed end time for the deal. The field will be truncated to the order of seconds during serving. "availableStartTime": "A String", # Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving. "createTime": "A String", # Creation time. @@ -439,7 +439,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. }, ], - "terms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "terms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.proposals.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.proposals.html index f557f5e0299..4bd39121f29 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.proposals.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.proposals.html @@ -152,7 +152,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -160,7 +160,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -191,7 +191,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -321,7 +321,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -332,7 +332,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -341,7 +341,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -593,7 +593,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -601,7 +601,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -632,7 +632,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -762,7 +762,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -773,7 +773,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -782,7 +782,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -1002,7 +1002,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -1010,7 +1010,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -1041,7 +1041,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -1171,7 +1171,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -1182,7 +1182,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -1191,7 +1191,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -1394,7 +1394,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -1402,7 +1402,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -1433,7 +1433,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -1563,7 +1563,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -1574,7 +1574,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -1583,7 +1583,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -1784,7 +1784,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -1792,7 +1792,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -1823,7 +1823,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -1953,7 +1953,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -1964,7 +1964,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -1973,7 +1973,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -2182,7 +2182,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -2190,7 +2190,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -2221,7 +2221,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -2351,7 +2351,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -2362,7 +2362,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -2371,7 +2371,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -2590,7 +2590,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -2598,7 +2598,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -2629,7 +2629,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -2759,7 +2759,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -2770,7 +2770,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -2779,7 +2779,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -3011,7 +3011,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -3019,7 +3019,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -3050,7 +3050,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -3180,7 +3180,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -3191,7 +3191,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -3200,7 +3200,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -3415,7 +3415,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -3423,7 +3423,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -3454,7 +3454,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -3584,7 +3584,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -3595,7 +3595,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -3604,7 +3604,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -3808,7 +3808,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -3816,7 +3816,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -3847,7 +3847,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -3977,7 +3977,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -3988,7 +3988,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -3997,7 +3997,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", @@ -4198,7 +4198,7 @@

Method Details

"deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. - "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. + "availableStartTime": "A String", # Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, @@ -4206,7 +4206,7 @@

Method Details

"createProductRevision": "A String", # Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. "createTime": "A String", # Output only. The time of the deal creation. "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. - "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. + "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. "creativeSpecifications": [ { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. @@ -4237,7 +4237,7 @@

Method Details

"sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. }, }, - "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. + "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) "description": "A String", # Publisher provided description for the terms. "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. @@ -4367,7 +4367,7 @@

Method Details

}, ], }, - "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. + "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, for example, URL, mobile applications. "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. "excludedAppIds": [ # A list of application IDs to be excluded. @@ -4378,7 +4378,7 @@

Method Details

], }, }, - "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. + "urlTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. "excludedUrls": [ # A list of URLs to be excluded. "A String", ], @@ -4387,7 +4387,7 @@

Method Details

], }, }, - "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. + "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, for example, operating system, device category. "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. "A String", diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidMetrics.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidMetrics.html index fe5c9d3d569..0c802b08150 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidMetrics.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidMetrics.html @@ -108,29 +108,29 @@

Method Details

{ # Response message for listing the metrics that are measured in number of bids. "bidMetricsRows": [ # List of rows, each containing a set of bid metrics. { # The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel; - "bids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that Ad Exchange received from the buyer. + "bids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that Ad Exchange received from the buyer. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "bidsInAuction": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that were permitted to compete in the auction. + "bidsInAuction": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that were permitted to compete in the auction. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "billedImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids for which the buyer was billed. + "billedImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids for which the buyer was billed. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "impressionsWon": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that won the auction. + "impressionsWon": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that won the auction. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "measurableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View). + "measurableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View). "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "reachedQueries": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that won the auction and also won the mediation waterfall (if any). + "reachedQueries": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that won the auction and also won the mediation waterfall (if any). "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. @@ -139,9 +139,9 @@

Method Details

"startTime": "A String", # The timestamp marking the start of the range (inclusive) for which data is included. }, }, - "viewableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids for which the corresponding impression was viewable (as defined by Active View). + "viewableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids for which the corresponding impression was viewable (as defined by Active View). "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, }, ], diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponseErrors.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponseErrors.html index 7aab09f8766..53207b05f1f 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponseErrors.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponseErrors.html @@ -109,9 +109,9 @@

Method Details

"calloutStatusRows": [ # List of rows, with counts of bid responses aggregated by callout status. { # The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status. "calloutStatusId": 42, # The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). - "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. + "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponsesWithoutBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponsesWithoutBids.html index c291b05865a..0a8bbf09ca8 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponsesWithoutBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponsesWithoutBids.html @@ -108,9 +108,9 @@

Method Details

{ # Response message for listing all reasons that bid responses were considered to have no applicable bids. "bidResponseWithoutBidsStatusRows": [ # List of rows, with counts of bid responses without bids aggregated by status. { # The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status. - "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which there was a bid response with the specified status. + "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which there was a bid response with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBidRequests.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBidRequests.html index 3e55d058900..4e8b1c49a7a 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBidRequests.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBidRequests.html @@ -109,9 +109,9 @@

Method Details

"calloutStatusRows": [ # List of rows, with counts of filtered bid requests aggregated by callout status. { # The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status. "calloutStatusId": 42, # The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). - "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. + "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.creatives.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.creatives.html index cb0ee6bb90e..7534464aa45 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.creatives.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.creatives.html @@ -109,9 +109,9 @@

Method Details

{ # Response message for listing all creatives associated with a given filtered bid reason. "filteredBidCreativeRows": [ # List of rows, with counts of bids with a given creative status aggregated by creative. { # The number of filtered bids with the specified dimension values that have the specified creative. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified creative. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified creative. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "creativeId": "A String", # The ID of the creative. "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.details.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.details.html index 5d78a88d86d..9ff426d1039 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.details.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.details.html @@ -109,10 +109,10 @@

Method Details

{ # Response message for listing all details associated with a given filtered bid reason. "detailType": "A String", # The type of detail that the detail IDs represent. "filteredBidDetailRows": [ # List of rows, with counts of bids with a given creative status aggregated by detail. - { # The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified detail. + { # The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (for example, creative status), that have the specified detail. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified detail. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "detail": "A String", # The ID of the detail, can be numeric or text. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message. "detailId": 42, # Note: this field will be deprecated, use "detail" field instead. When "detail" field represents an integer value, this field is populated as the same integer value "detail" field represents, otherwise this field will be 0. The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.html index 5ef8c076a4a..575d425312a 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.html @@ -116,11 +116,11 @@

Method Details

An object of the form: { # Response message for listing all reasons that bids were filtered from the auction. - "creativeStatusRows": [ # List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status). + "creativeStatusRows": [ # List of rows, with counts of filtered bids aggregated by filtering reason (for example, creative status). { # The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified status. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "creativeStatusId": 42, # The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.html index 14d642e54ee..2dbb70088f2 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.html @@ -147,7 +147,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". +{ # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -163,15 +163,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -180,14 +180,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. } isTransient: boolean, Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. @@ -199,7 +199,7 @@

Method Details

Returns: An object of the form: - { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". + { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -215,15 +215,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -232,14 +232,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. }
@@ -275,7 +275,7 @@

Method Details

Returns: An object of the form: - { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". + { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -291,15 +291,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -308,14 +308,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. }
@@ -337,7 +337,7 @@

Method Details

{ # Response message for listing filter sets. "filterSets": [ # The filter sets belonging to the buyer. - { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". + { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -353,15 +353,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -370,14 +370,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.impressionMetrics.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.impressionMetrics.html index c1718fb3c76..c5c48f61d9a 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.impressionMetrics.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.impressionMetrics.html @@ -108,21 +108,21 @@

Method Details

{ # Response message for listing the metrics that are measured in number of impressions. "impressionMetricsRows": [ # List of rows, each containing a set of impression metrics. { # The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel. - "availableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable. + "availableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "bidRequests": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which Ad Exchange sent the buyer a bid request. + "bidRequests": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which Ad Exchange sent the buyer a bid request. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "inventoryMatches": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions that match the buyer's inventory pretargeting. + "inventoryMatches": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions that match the buyer's inventory pretargeting. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "responsesWithBids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid. + "responsesWithBids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. @@ -131,9 +131,9 @@

Method Details

"startTime": "A String", # The timestamp marking the start of the range (inclusive) for which data is included. }, }, - "successfulResponses": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which the buyer successfully sent a response to Ad Exchange. + "successfulResponses": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which the buyer successfully sent a response to Ad Exchange. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, }, ], diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.losingBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.losingBids.html index d71200298ce..6856e39f893 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.losingBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.losingBids.html @@ -106,11 +106,11 @@

Method Details

An object of the form: { # Response message for listing all reasons that bids lost in the auction. - "creativeStatusRows": [ # List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status). + "creativeStatusRows": [ # List of rows, with counts of losing bids aggregated by loss reason (for example, creative status). { # The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified status. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "creativeStatusId": 42, # The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.nonBillableWinningBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.nonBillableWinningBids.html index 57e1436810b..6fce518a6ee 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.nonBillableWinningBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.accounts.filterSets.nonBillableWinningBids.html @@ -109,9 +109,9 @@

Method Details

"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results. "nonBillableWinningBidStatusRows": [ # List of rows, with counts of bids not billed aggregated by reason. { # The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified status. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidMetrics.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidMetrics.html index dd96c6d85c5..ef3c85b799a 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidMetrics.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidMetrics.html @@ -108,29 +108,29 @@

Method Details

{ # Response message for listing the metrics that are measured in number of bids. "bidMetricsRows": [ # List of rows, each containing a set of bid metrics. { # The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel; - "bids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that Ad Exchange received from the buyer. + "bids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that Ad Exchange received from the buyer. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "bidsInAuction": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that were permitted to compete in the auction. + "bidsInAuction": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that were permitted to compete in the auction. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "billedImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids for which the buyer was billed. + "billedImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids for which the buyer was billed. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "impressionsWon": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that won the auction. + "impressionsWon": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that won the auction. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "measurableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View). + "measurableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View). "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "reachedQueries": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids that won the auction and also won the mediation waterfall (if any). + "reachedQueries": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids that won the auction and also won the mediation waterfall (if any). "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. @@ -139,9 +139,9 @@

Method Details

"startTime": "A String", # The timestamp marking the start of the range (inclusive) for which data is included. }, }, - "viewableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids for which the corresponding impression was viewable (as defined by Active View). + "viewableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids for which the corresponding impression was viewable (as defined by Active View). "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, }, ], diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponseErrors.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponseErrors.html index 41d6139ccd8..6cd8506d4b1 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponseErrors.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponseErrors.html @@ -109,9 +109,9 @@

Method Details

"calloutStatusRows": [ # List of rows, with counts of bid responses aggregated by callout status. { # The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status. "calloutStatusId": 42, # The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). - "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. + "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponsesWithoutBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponsesWithoutBids.html index f158a7f1b8f..bb7ac51b72e 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponsesWithoutBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.bidResponsesWithoutBids.html @@ -108,9 +108,9 @@

Method Details

{ # Response message for listing all reasons that bid responses were considered to have no applicable bids. "bidResponseWithoutBidsStatusRows": [ # List of rows, with counts of bid responses without bids aggregated by status. { # The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status. - "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which there was a bid response with the specified status. + "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which there was a bid response with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBidRequests.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBidRequests.html index 676070acfd7..923458741a4 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBidRequests.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBidRequests.html @@ -109,9 +109,9 @@

Method Details

"calloutStatusRows": [ # List of rows, with counts of filtered bid requests aggregated by callout status. { # The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status. "calloutStatusId": 42, # The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes). - "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. + "impressionCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which there was a bid request or bid response with the specified callout status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.creatives.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.creatives.html index 4ae92086655..a9db1316028 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.creatives.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.creatives.html @@ -109,9 +109,9 @@

Method Details

{ # Response message for listing all creatives associated with a given filtered bid reason. "filteredBidCreativeRows": [ # List of rows, with counts of bids with a given creative status aggregated by creative. { # The number of filtered bids with the specified dimension values that have the specified creative. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified creative. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified creative. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "creativeId": "A String", # The ID of the creative. "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.details.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.details.html index aa0a9e132e8..fdbcffa0033 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.details.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.details.html @@ -109,10 +109,10 @@

Method Details

{ # Response message for listing all details associated with a given filtered bid reason. "detailType": "A String", # The type of detail that the detail IDs represent. "filteredBidDetailRows": [ # List of rows, with counts of bids with a given creative status aggregated by detail. - { # The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified detail. + { # The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (for example, creative status), that have the specified detail. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified detail. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "detail": "A String", # The ID of the detail, can be numeric or text. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message. "detailId": 42, # Note: this field will be deprecated, use "detail" field instead. When "detail" field represents an integer value, this field is populated as the same integer value "detail" field represents, otherwise this field will be 0. The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.html index bbd4d597999..e8343981468 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.filteredBids.html @@ -116,11 +116,11 @@

Method Details

An object of the form: { # Response message for listing all reasons that bids were filtered from the auction. - "creativeStatusRows": [ # List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status). + "creativeStatusRows": [ # List of rows, with counts of filtered bids aggregated by filtering reason (for example, creative status). { # The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified status. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "creativeStatusId": 42, # The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.html index 490738770b0..45bcb15146e 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.html @@ -147,7 +147,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". +{ # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -163,15 +163,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -180,14 +180,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. } isTransient: boolean, Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. @@ -199,7 +199,7 @@

Method Details

Returns: An object of the form: - { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". + { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -215,15 +215,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -232,14 +232,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. }
@@ -275,7 +275,7 @@

Method Details

Returns: An object of the form: - { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". + { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -291,15 +291,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -308,14 +308,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. } @@ -337,7 +337,7 @@

Method Details

{ # Response message for listing filter sets. "filterSets": [ # The filter sets belonging to the buyer. - { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". + { # A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)". "absoluteDateRange": { # An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. # An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. "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 end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -353,15 +353,15 @@

Method Details

"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. "A String", ], - "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. - "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. + "dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. "environment": "A String", # The environment on which to filter; optional. "format": "A String", # Creative format bidded on or allowed to bid on, can be empty. "formats": [ # Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items. "A String", ], "name": "A String", # A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. - "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). + "platforms": [ # The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). "A String", ], "publisherIdentifiers": [ # For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. @@ -370,14 +370,14 @@

Method Details

"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. # An open-ended realtime time range, defined by the aggregation start timestamp. "startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation. }, - "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. - "durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. - "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. + "relativeDateRange": { # A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 # A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. + "durationDays": 42, # The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. + "offsetDays": 42, # The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. }, - "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. + "sellerNetworkIds": [ # For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. 42, ], - "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired; optional. + "timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is preferred; optional. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.impressionMetrics.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.impressionMetrics.html index 9c6fb988297..0c80701e6bf 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.impressionMetrics.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.impressionMetrics.html @@ -108,21 +108,21 @@

Method Details

{ # Response message for listing the metrics that are measured in number of impressions. "impressionMetricsRows": [ # List of rows, each containing a set of impression metrics. { # The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel. - "availableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable. + "availableImpressions": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "bidRequests": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which Ad Exchange sent the buyer a bid request. + "bidRequests": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which Ad Exchange sent the buyer a bid request. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "inventoryMatches": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions that match the buyer's inventory pretargeting. + "inventoryMatches": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions that match the buyer's inventory pretargeting. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, - "responsesWithBids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid. + "responsesWithBids": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. @@ -131,9 +131,9 @@

Method Details

"startTime": "A String", # The timestamp marking the start of the range (inclusive) for which data is included. }, }, - "successfulResponses": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of impressions for which the buyer successfully sent a response to Ad Exchange. + "successfulResponses": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of impressions for which the buyer successfully sent a response to Ad Exchange. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, }, ], diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.losingBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.losingBids.html index 21943d62af5..92089982966 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.losingBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.losingBids.html @@ -106,11 +106,11 @@

Method Details

An object of the form: { # Response message for listing all reasons that bids lost in the auction. - "creativeStatusRows": [ # List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status). + "creativeStatusRows": [ # List of rows, with counts of losing bids aggregated by loss reason (for example, creative status). { # The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified status. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "creativeStatusId": 42, # The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. diff --git a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.nonBillableWinningBids.html b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.nonBillableWinningBids.html index f7eb3d60d56..73aed61f25b 100644 --- a/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.nonBillableWinningBids.html +++ b/docs/dyn/adexchangebuyer2_v2beta1.bidders.filterSets.nonBillableWinningBids.html @@ -109,9 +109,9 @@

Method Details

"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results. "nonBillableWinningBidStatusRows": [ # List of rows, with counts of bids not billed aggregated by reason. { # The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status. - "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). # The number of bids with the specified status. + "bidCount": { # A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled). # The number of bids with the specified status. "value": "A String", # The expected value of the metric. - "variance": "A String", # The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + "variance": "A String", # The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value }, "rowDimensions": { # A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. # The values of all dimensions associated with metric values in this row. "publisherIdentifier": "A String", # The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested. diff --git a/docs/dyn/analyticshub_v1.html b/docs/dyn/analyticshub_v1.html new file mode 100644 index 00000000000..d95beac3483 --- /dev/null +++ b/docs/dyn/analyticshub_v1.html @@ -0,0 +1,116 @@ + + + +

Analytics Hub API

+

Instance Methods

+

+ organizations() +

+

Returns the organizations Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

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

Analytics Hub API . organizations

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html new file mode 100644 index 00000000000..1ce436d2257 --- /dev/null +++ b/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html @@ -0,0 +1,138 @@ + + + +

Analytics Hub API . organizations . locations . dataExchanges

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists all data exchanges from projects in a given organization and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(organization, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all data exchanges from projects in a given organization and location.
+
+Args:
+  organization: string, Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`. (required)
+  pageSize: 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.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing data exchanges in an organization and location.
+  "dataExchanges": [ # The list of data exchanges.
+    { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
+      "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+      "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+      "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.
+      "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.
+    },
+  ],
+  "nextPageToken": "A String", # A token to request 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/analyticshub_v1.organizations.locations.html b/docs/dyn/analyticshub_v1.organizations.locations.html new file mode 100644 index 00000000000..105b24e5572 --- /dev/null +++ b/docs/dyn/analyticshub_v1.organizations.locations.html @@ -0,0 +1,91 @@ + + + +

Analytics Hub API . organizations . locations

+

Instance Methods

+

+ dataExchanges() +

+

Returns the dataExchanges Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticshub_v1.projects.html b/docs/dyn/analyticshub_v1.projects.html new file mode 100644 index 00000000000..38c358811c6 --- /dev/null +++ b/docs/dyn/analyticshub_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Analytics Hub API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html new file mode 100644 index 00000000000..1f1de8ae27e --- /dev/null +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html @@ -0,0 +1,456 @@ + + + +

Analytics Hub API . projects . locations . dataExchanges

+

Instance Methods

+

+ listings() +

+

Returns the listings Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, dataExchangeId=None, x__xgafv=None)

+

Creates a new data exchange.

+

+ delete(name, x__xgafv=None)

+

Deletes an existing data exchange.

+

+ get(name, x__xgafv=None)

+

Gets the details of a data exchange.

+

+ getIamPolicy(resource, body=None, x__xgafv=None)

+

Gets the IAM policy.

+

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

+

Lists all data exchanges in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an existing data exchange.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the IAM policy.

+

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

+

Returns the permissions that a caller has.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, dataExchangeId=None, x__xgafv=None) +
Creates a new data exchange.
+
+Args:
+  parent: string, Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
+  "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+  "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.
+  "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.
+}
+
+  dataExchangeId: string, Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
+  "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+  "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.
+  "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.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an existing data exchange.
+
+Args:
+  name: string, Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the details of a data exchange.
+
+Args:
+  name: string, Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
+  "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+  "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.
+  "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.
+}
+
+ +
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the IAM policy.
+
+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)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # 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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes 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, x__xgafv=None) +
Lists all data exchanges in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`. (required)
+  pageSize: 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.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to the list of data exchanges.
+  "dataExchanges": [ # The list of data exchanges.
+    { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
+      "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+      "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+      "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.
+      "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.
+    },
+  ],
+  "nextPageToken": "A String", # A token to request 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(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing data exchange.
+
+Args:
+  name: string, Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
+  "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+  "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.
+  "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.
+}
+
+  updateMask: string, Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
+  "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
+  "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.
+  "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.
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the IAM 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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes 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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes 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 the permissions that a caller has.
+
+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/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html new file mode 100644 index 00000000000..440eb6b29b0 --- /dev/null +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -0,0 +1,580 @@ + + + +

Analytics Hub API . projects . locations . dataExchanges . listings

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, listingId=None, x__xgafv=None)

+

Creates a new listing.

+

+ delete(name, x__xgafv=None)

+

Deletes a listing.

+

+ get(name, x__xgafv=None)

+

Gets the details of a listing.

+

+ getIamPolicy(resource, body=None, x__xgafv=None)

+

Gets the IAM policy.

+

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

+

Lists all listings in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an existing listing.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the IAM policy.

+

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

+

Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

+

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

+

Returns the permissions that a caller has.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, listingId=None, x__xgafv=None) +
Creates a new listing.
+
+Args:
+  parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
+  "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
+    "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
+  },
+  "categories": [ # Optional. Categories of the listing. Up to two categories are allowed.
+    "A String",
+  ],
+  "dataProvider": { # Contains details of the data provider. # Optional. Details of the data provider who owns the source data.
+    "name": "A String", # Optional. Name of the data provider.
+    "primaryContact": "A String", # Optional. Email or URL of the data provider. Max Length: 1000 bytes.
+  },
+  "description": "A String", # Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "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.
+  "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.
+    "name": "A String", # Optional. Name of the listing publisher.
+    "primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.
+  },
+  "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
+  "state": "A String", # Output only. Current state of the listing.
+}
+
+  listingId: string, Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
+  "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
+    "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
+  },
+  "categories": [ # Optional. Categories of the listing. Up to two categories are allowed.
+    "A String",
+  ],
+  "dataProvider": { # Contains details of the data provider. # Optional. Details of the data provider who owns the source data.
+    "name": "A String", # Optional. Name of the data provider.
+    "primaryContact": "A String", # Optional. Email or URL of the data provider. Max Length: 1000 bytes.
+  },
+  "description": "A String", # Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "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.
+  "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.
+    "name": "A String", # Optional. Name of the listing publisher.
+    "primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.
+  },
+  "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
+  "state": "A String", # Output only. Current state of the listing.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a listing.
+
+Args:
+  name: string, Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the details of a listing.
+
+Args:
+  name: string, Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
+  "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
+    "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
+  },
+  "categories": [ # Optional. Categories of the listing. Up to two categories are allowed.
+    "A String",
+  ],
+  "dataProvider": { # Contains details of the data provider. # Optional. Details of the data provider who owns the source data.
+    "name": "A String", # Optional. Name of the data provider.
+    "primaryContact": "A String", # Optional. Email or URL of the data provider. Max Length: 1000 bytes.
+  },
+  "description": "A String", # Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "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.
+  "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.
+    "name": "A String", # Optional. Name of the listing publisher.
+    "primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.
+  },
+  "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
+  "state": "A String", # Output only. Current state of the listing.
+}
+
+ +
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the IAM policy.
+
+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)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # 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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes 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, x__xgafv=None) +
Lists all listings in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+  pageSize: 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.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to the list of Listings.
+  "listings": [ # The list of Listing.
+    { # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
+      "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
+        "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
+      },
+      "categories": [ # Optional. Categories of the listing. Up to two categories are allowed.
+        "A String",
+      ],
+      "dataProvider": { # Contains details of the data provider. # Optional. Details of the data provider who owns the source data.
+        "name": "A String", # Optional. Name of the data provider.
+        "primaryContact": "A String", # Optional. Email or URL of the data provider. Max Length: 1000 bytes.
+      },
+      "description": "A String", # Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+      "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.
+      "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.
+        "name": "A String", # Optional. Name of the listing publisher.
+        "primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.
+      },
+      "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
+      "state": "A String", # Output only. Current state of the listing.
+    },
+  ],
+  "nextPageToken": "A String", # A token to request 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(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing listing.
+
+Args:
+  name: string, Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
+  "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
+    "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
+  },
+  "categories": [ # Optional. Categories of the listing. Up to two categories are allowed.
+    "A String",
+  ],
+  "dataProvider": { # Contains details of the data provider. # Optional. Details of the data provider who owns the source data.
+    "name": "A String", # Optional. Name of the data provider.
+    "primaryContact": "A String", # Optional. Email or URL of the data provider. Max Length: 1000 bytes.
+  },
+  "description": "A String", # Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "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.
+  "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.
+    "name": "A String", # Optional. Name of the listing publisher.
+    "primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.
+  },
+  "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
+  "state": "A String", # Output only. Current state of the listing.
+}
+
+  updateMask: string, Required. Field mask specifies the fields to update in the listing resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
+  "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Required. Shared dataset i.e. BigQuery dataset source.
+    "dataset": "A String", # Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
+  },
+  "categories": [ # Optional. Categories of the listing. Up to two categories are allowed.
+    "A String",
+  ],
+  "dataProvider": { # Contains details of the data provider. # Optional. Details of the data provider who owns the source data.
+    "name": "A String", # Optional. Name of the data provider.
+    "primaryContact": "A String", # Optional. Email or URL of the data provider. Max Length: 1000 bytes.
+  },
+  "description": "A String", # Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
+  "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.
+  "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.
+    "name": "A String", # Optional. Name of the listing publisher.
+    "primaryContact": "A String", # Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.
+  },
+  "requestAccess": "A String", # Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
+  "state": "A String", # Output only. Current state of the listing.
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the IAM 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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes 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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes 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).
+}
+
+ +
+ subscribe(name, body=None, x__xgafv=None) +
Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
+
+Args:
+  name: string, Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for subscribing to a listing.
+  "destinationDataset": { # Defines the destination bigquery dataset. # BigQuery destination dataset to create for the subscriber.
+    "datasetReference": { # Contains the reference that identifies a destination bigquery dataset. # Required. A reference that identifies the destination dataset.
+      "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+      "projectId": "A String", # Required. The ID of the project containing this dataset.
+    },
+    "description": "A String", # Optional. A user-friendly description of the dataset.
+    "friendlyName": "A String", # Optional. A descriptive name for the dataset.
+    "labels": { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
+      "a_key": "A String",
+    },
+    "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response when you subscribe to a listing.
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the permissions that a caller has.
+
+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/docs/dyn/analyticshub_v1.projects.locations.html b/docs/dyn/analyticshub_v1.projects.locations.html new file mode 100644 index 00000000000..fde85f54c15 --- /dev/null +++ b/docs/dyn/analyticshub_v1.projects.locations.html @@ -0,0 +1,91 @@ + + + +

Analytics Hub API . projects . locations

+

Instance Methods

+

+ dataExchanges() +

+

Returns the dataExchanges Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticshub_v1beta1.projects.locations.html b/docs/dyn/analyticshub_v1beta1.projects.locations.html index 4be65219b78..4b54383277e 100644 --- a/docs/dyn/analyticshub_v1beta1.projects.locations.html +++ b/docs/dyn/analyticshub_v1beta1.projects.locations.html @@ -82,95 +82,10 @@

Instance Methods

close()

Close httplib2 connections.

-

- get(name, x__xgafv=None)

-

Gets information about a location.

-

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

-

Lists information about the supported locations for this service.

-

- list_next()

-

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
-
- get(name, x__xgafv=None) -
Gets information about a location.
-
-Args:
-  name: string, Resource name for the location. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A resource that represents Google Cloud Platform location.
-  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
-  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
-    "a_key": "A String",
-  },
-  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
-  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
-}
-
- -
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service.
-
-Args:
-  name: string, The resource that owns the locations collection, if applicable. (required)
-  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
-  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
-  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The response message for Locations.ListLocations.
-  "locations": [ # A list of locations that matches the specified filter in the request.
-    { # A resource that represents Google Cloud Platform location.
-      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
-      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
-        "a_key": "A String",
-      },
-      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
-      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
-    },
-  ],
-  "nextPageToken": "A String", # The standard List next-page token.
-}
-
- -
- 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/androidenterprise_v1.entitlements.html b/docs/dyn/androidenterprise_v1.entitlements.html index f13e292139d..22d1e804d22 100644 --- a/docs/dyn/androidenterprise_v1.entitlements.html +++ b/docs/dyn/androidenterprise_v1.entitlements.html @@ -79,16 +79,16 @@

Instance Methods

Close httplib2 connections.

delete(enterpriseId, userId, entitlementId, x__xgafv=None)

-

Removes an entitlement to an app for a user.

+

Removes an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

get(enterpriseId, userId, entitlementId, x__xgafv=None)

-

Retrieves details of an entitlement.

+

Retrieves details of an entitlement. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

list(enterpriseId, userId, x__xgafv=None)

-

Lists all entitlements for the specified user. Only the ID is set.

+

Lists all entitlements for the specified user. Only the ID is set. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None)

-

Adds or updates an entitlement to an app for a user.

+

Adds or updates an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Method Details

close() @@ -97,7 +97,7 @@

Method Details

delete(enterpriseId, userId, entitlementId, x__xgafv=None) -
Removes an entitlement to an app for a user.
+  
Removes an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -112,7 +112,7 @@ 

Method Details

get(enterpriseId, userId, entitlementId, x__xgafv=None) -
Retrieves details of an entitlement.
+  
Retrieves details of an entitlement. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -134,7 +134,7 @@ 

Method Details

list(enterpriseId, userId, x__xgafv=None) -
Lists all entitlements for the specified user. Only the ID is set.
+  
Lists all entitlements for the specified user. Only the ID is set. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -159,7 +159,7 @@ 

Method Details

update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None) -
Adds or updates an entitlement to an app for a user.
+  
Adds or updates an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/androidenterprise_v1.grouplicenses.html b/docs/dyn/androidenterprise_v1.grouplicenses.html
index b6891468b9b..c24b566611c 100644
--- a/docs/dyn/androidenterprise_v1.grouplicenses.html
+++ b/docs/dyn/androidenterprise_v1.grouplicenses.html
@@ -79,10 +79,10 @@ 

Instance Methods

Close httplib2 connections.

get(enterpriseId, groupLicenseId, x__xgafv=None)

-

Retrieves details of an enterprise's group license for a product.

+

Retrieves details of an enterprise's group license for a product. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

list(enterpriseId, x__xgafv=None)

-

Retrieves IDs of all products for which the enterprise has a group license.

+

Retrieves IDs of all products for which the enterprise has a group license. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Method Details

close() @@ -91,7 +91,7 @@

Method Details

get(enterpriseId, groupLicenseId, x__xgafv=None) -
Retrieves details of an enterprise's group license for a product.
+  
Retrieves details of an enterprise's group license for a product. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -116,7 +116,7 @@ 

Method Details

list(enterpriseId, x__xgafv=None) -
Retrieves IDs of all products for which the enterprise has a group license.
+  
Retrieves IDs of all products for which the enterprise has a group license. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/androidenterprise_v1.grouplicenseusers.html b/docs/dyn/androidenterprise_v1.grouplicenseusers.html
index b6572749d32..b23c94cb4d6 100644
--- a/docs/dyn/androidenterprise_v1.grouplicenseusers.html
+++ b/docs/dyn/androidenterprise_v1.grouplicenseusers.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

list(enterpriseId, groupLicenseId, x__xgafv=None)

-

Retrieves the IDs of the users who have been granted entitlements under the license.

+

Retrieves the IDs of the users who have been granted entitlements under the license. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Method Details

close() @@ -88,7 +88,7 @@

Method Details

list(enterpriseId, groupLicenseId, x__xgafv=None) -
Retrieves the IDs of the users who have been granted entitlements under the license.
+  
Retrieves the IDs of the users who have been granted entitlements under the license. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/androidenterprise_v1.products.html b/docs/dyn/androidenterprise_v1.products.html
index 27c8f1cb94c..790fd764bbf 100644
--- a/docs/dyn/androidenterprise_v1.products.html
+++ b/docs/dyn/androidenterprise_v1.products.html
@@ -76,13 +76,13 @@ 

Google Play EMM API . approve(enterpriseId, productId, body=None, x__xgafv=None)

-

Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design.

+

Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

close()

Close httplib2 connections.

generateApprovalUrl(enterpriseId, productId, languageCode=None, x__xgafv=None)

-

Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.

+

Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

get(enterpriseId, productId, language=None, x__xgafv=None)

Retrieves details of a product for display to an enterprise admin.

@@ -94,14 +94,14 @@

Instance Methods

Retrieves the Android app permissions required by this app.

list(enterpriseId, approved=None, language=None, maxResults=None, query=None, token=None, x__xgafv=None)

-

Finds approved products that match a query, or all approved products if there is no query.

+

Finds approved products that match a query, or all approved products if there is no query. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

unapprove(enterpriseId, productId, x__xgafv=None)

-

Unapproves the specified product (and the relevant app permissions, if any)

+

Unapproves the specified product (and the relevant app permissions, if any) **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Method Details

approve(enterpriseId, productId, body=None, x__xgafv=None) -
 Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. 
+  
 Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. 
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -130,7 +130,7 @@ 

Method Details

generateApprovalUrl(enterpriseId, productId, languageCode=None, x__xgafv=None) -
Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.
+  
Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. 
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -328,7 +328,7 @@ 

Method Details

list(enterpriseId, approved=None, language=None, maxResults=None, query=None, token=None, x__xgafv=None) -
Finds approved products that match a query, or all approved products if there is no query.
+  
Finds approved products that match a query, or all approved products if there is no query. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. 
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -448,7 +448,7 @@ 

Method Details

unapprove(enterpriseId, productId, x__xgafv=None) -
Unapproves the specified product (and the relevant app permissions, if any)
+  
Unapproves the specified product (and the relevant app permissions, if any) **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html
index 23040c2bcd7..25b59a539ab 100644
--- a/docs/dyn/androidenterprise_v1.users.html
+++ b/docs/dyn/androidenterprise_v1.users.html
@@ -88,7 +88,7 @@ 

Instance Methods

Retrieves a user's details.

getAvailableProductSet(enterpriseId, userId, x__xgafv=None)

-

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

+

Retrieves the set of products a user is entitled to access. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

insert(enterpriseId, body=None, x__xgafv=None)

Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.

@@ -100,7 +100,7 @@

Instance Methods

Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.

setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None)

-

Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.

+

Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

update(enterpriseId, userId, body=None, x__xgafv=None)

Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.

@@ -171,7 +171,7 @@

Method Details

getAvailableProductSet(enterpriseId, userId, x__xgafv=None) -
Retrieves the set of products a user is entitled to access.
+  
Retrieves the set of products a user is entitled to access. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -284,7 +284,7 @@ 

Method Details

setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None) -
Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
+  
Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html
index 88bcd012a5a..7d196bf8516 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.policies.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html
@@ -423,7 +423,7 @@ 

Method Details

}, }, ], - "shareLocationDisabled": True or False, # Whether location sharing is disabled. + "shareLocationDisabled": True or False, # Whether location sharing is disabled. share_location_disabled is supported for both fully managed devices and personally owned work profiles. "shortSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. If the message is longer than 200 characters it may be truncated. "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. "localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr. @@ -485,7 +485,7 @@

Method Details

"usbMassStorageEnabled": True or False, # Whether USB storage is enabled. Deprecated. "version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. - "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). + "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. }
@@ -802,7 +802,7 @@

Method Details

}, }, ], - "shareLocationDisabled": True or False, # Whether location sharing is disabled. + "shareLocationDisabled": True or False, # Whether location sharing is disabled. share_location_disabled is supported for both fully managed devices and personally owned work profiles. "shortSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. If the message is longer than 200 characters it may be truncated. "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. "localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr. @@ -864,7 +864,7 @@

Method Details

"usbMassStorageEnabled": True or False, # Whether USB storage is enabled. Deprecated. "version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. - "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). + "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. }, ], @@ -1187,7 +1187,7 @@

Method Details

}, }, ], - "shareLocationDisabled": True or False, # Whether location sharing is disabled. + "shareLocationDisabled": True or False, # Whether location sharing is disabled. share_location_disabled is supported for both fully managed devices and personally owned work profiles. "shortSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. If the message is longer than 200 characters it may be truncated. "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. "localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr. @@ -1249,7 +1249,7 @@

Method Details

"usbMassStorageEnabled": True or False, # Whether USB storage is enabled. Deprecated. "version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. - "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). + "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. } @@ -1555,7 +1555,7 @@

Method Details

}, }, ], - "shareLocationDisabled": True or False, # Whether location sharing is disabled. + "shareLocationDisabled": True or False, # Whether location sharing is disabled. share_location_disabled is supported for both fully managed devices and personally owned work profiles. "shortSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. If the message is longer than 200 characters it may be truncated. "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. "localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr. @@ -1617,7 +1617,7 @@

Method Details

"usbMassStorageEnabled": True or False, # Whether USB storage is enabled. Deprecated. "version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. - "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). + "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi access points is disabled. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. }
diff --git a/docs/dyn/apigateway_v1.projects.locations.apis.configs.html b/docs/dyn/apigateway_v1.projects.locations.apis.configs.html index 1fa6237c084..52415e8c484 100644 --- a/docs/dyn/apigateway_v1.projects.locations.apis.configs.html +++ b/docs/dyn/apigateway_v1.projects.locations.apis.configs.html @@ -323,7 +323,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -528,7 +528,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -570,7 +570,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/apigateway_v1.projects.locations.apis.html b/docs/dyn/apigateway_v1.projects.locations.apis.html index 4028be2057f..f8b37ea0f1a 100644 --- a/docs/dyn/apigateway_v1.projects.locations.apis.html +++ b/docs/dyn/apigateway_v1.projects.locations.apis.html @@ -265,7 +265,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -412,7 +412,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -454,7 +454,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/apigateway_v1.projects.locations.gateways.html b/docs/dyn/apigateway_v1.projects.locations.gateways.html index 09d0b1a4ff9..3db89639145 100644 --- a/docs/dyn/apigateway_v1.projects.locations.gateways.html +++ b/docs/dyn/apigateway_v1.projects.locations.gateways.html @@ -262,7 +262,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -411,7 +411,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -453,7 +453,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.entries.html b/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.entries.html index 2a2698dd6a0..21cf8a6be5b 100644 --- a/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.entries.html +++ b/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.entries.html @@ -79,16 +79,16 @@

Instance Methods

Close httplib2 connections.

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

-

Creates key value entries in a key value map scoped to an organization, environment, or API proxy.

+

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

delete(name, x__xgafv=None)

-

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.

+

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

get(name, x__xgafv=None)

-

Get the Key value entry value for org, env or apis scoped Key value map.

+

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

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

-

Lists key value entries for key values maps scoped to an organization, environment, or API proxy.

+

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

list_next()

Retrieves the next page of results.

@@ -100,14 +100,14 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates key value entries in a key value map scoped to an organization, environment, or API proxy.
+  
Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   parent: string, Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Key value map pair where the value represents the data associated with the corresponding key.
+{ # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
   "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
   "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
 }
@@ -120,7 +120,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -128,7 +128,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.
+  
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   name: string, Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
@@ -140,7 +140,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -148,7 +148,7 @@

Method Details

get(name, x__xgafv=None) -
Get the Key value entry value for org, env or apis scoped Key value map.
+  
Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   name: string, Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
@@ -160,7 +160,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -168,7 +168,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists key value entries for key values maps scoped to an organization, environment, or API proxy.
+  
Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   parent: string, Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. (required)
@@ -182,9 +182,9 @@ 

Method Details

Returns: An object of the form: - { # The request structure for listing Key value map keys and its corrresponding values. + { # The request structure for listing key value map keys and its corresponding values. "keyValueEntries": [ # One or more key value map keys and values. - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }, diff --git a/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.entries.html b/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.entries.html index e482db18b30..d82e4631525 100644 --- a/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.entries.html +++ b/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.entries.html @@ -79,16 +79,16 @@

Instance Methods

Close httplib2 connections.

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

-

Creates key value entries in a key value map scoped to an organization, environment, or API proxy.

+

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

delete(name, x__xgafv=None)

-

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.

+

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

get(name, x__xgafv=None)

-

Get the Key value entry value for org, env or apis scoped Key value map.

+

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

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

-

Lists key value entries for key values maps scoped to an organization, environment, or API proxy.

+

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

list_next()

Retrieves the next page of results.

@@ -100,14 +100,14 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates key value entries in a key value map scoped to an organization, environment, or API proxy.
+  
Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   parent: string, Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Key value map pair where the value represents the data associated with the corresponding key.
+{ # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
   "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
   "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
 }
@@ -120,7 +120,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -128,7 +128,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.
+  
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   name: string, Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
@@ -140,7 +140,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -148,7 +148,7 @@

Method Details

get(name, x__xgafv=None) -
Get the Key value entry value for org, env or apis scoped Key value map.
+  
Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   name: string, Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
@@ -160,7 +160,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -168,7 +168,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists key value entries for key values maps scoped to an organization, environment, or API proxy.
+  
Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   parent: string, Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. (required)
@@ -182,9 +182,9 @@ 

Method Details

Returns: An object of the form: - { # The request structure for listing Key value map keys and its corrresponding values. + { # The request structure for listing key value map keys and its corresponding values. "keyValueEntries": [ # One or more key value map keys and values. - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }, diff --git a/docs/dyn/apigee_v1.organizations.keyvaluemaps.entries.html b/docs/dyn/apigee_v1.organizations.keyvaluemaps.entries.html index 7fd11f92b8f..267e2ea3c74 100644 --- a/docs/dyn/apigee_v1.organizations.keyvaluemaps.entries.html +++ b/docs/dyn/apigee_v1.organizations.keyvaluemaps.entries.html @@ -79,16 +79,16 @@

Instance Methods

Close httplib2 connections.

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

-

Creates key value entries in a key value map scoped to an organization, environment, or API proxy.

+

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

delete(name, x__xgafv=None)

-

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.

+

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

get(name, x__xgafv=None)

-

Get the Key value entry value for org, env or apis scoped Key value map.

+

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

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

-

Lists key value entries for key values maps scoped to an organization, environment, or API proxy.

+

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.

list_next()

Retrieves the next page of results.

@@ -100,14 +100,14 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates key value entries in a key value map scoped to an organization, environment, or API proxy.
+  
Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   parent: string, Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Key value map pair where the value represents the data associated with the corresponding key.
+{ # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.
   "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries.
   "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key.
 }
@@ -120,7 +120,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -128,7 +128,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.
+  
Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   name: string, Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
@@ -140,7 +140,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -148,7 +148,7 @@

Method Details

get(name, x__xgafv=None) -
Get the Key value entry value for org, env or apis scoped Key value map.
+  
Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   name: string, Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. (required)
@@ -160,7 +160,7 @@ 

Method Details

Returns: An object of the form: - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }
@@ -168,7 +168,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists key value entries for key values maps scoped to an organization, environment, or API proxy.
+  
Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
 
 Args:
   parent: string, Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. (required)
@@ -182,9 +182,9 @@ 

Method Details

Returns: An object of the form: - { # The request structure for listing Key value map keys and its corrresponding values. + { # The request structure for listing key value map keys and its corresponding values. "keyValueEntries": [ # One or more key value map keys and values. - { # Key value map pair where the value represents the data associated with the corresponding key. + { # Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher. "name": "A String", # Resource URI that can be used to identify the scope of the key value map entries. "value": "A String", # Required. Data or payload that is being retrieved and associated with the unique key. }, diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html index 1885e5c4553..83c83772685 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html @@ -89,6 +89,11 @@

Instance Methods

Returns the files Resource.

+

+ kfpArtifacts() +

+

Returns the kfpArtifacts Resource.

+

mavenArtifacts()

diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.kfpArtifacts.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.kfpArtifacts.html new file mode 100644 index 00000000000..72376e10c91 --- /dev/null +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.kfpArtifacts.html @@ -0,0 +1,138 @@ + + + +

Artifact Registry API . projects . locations . repositories . kfpArtifacts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Directly uploads a KFP artifact. The returned Operation will complete once the resource is uploaded. Package, Version, and File resources will be created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will be overwritten.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
Directly uploads a KFP artifact. The returned Operation will complete once the resource is uploaded. Package, Version, and File resources will be created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will be overwritten.
+
+Args:
+  parent: string, The resource name of the repository where the KFP artifact will be uploaded. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to upload an artifact.
+  "description": "A String", # Description of the package version.
+  "tags": [ # Tags to be created with the version.
+    "A String",
+  ],
+}
+
+  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:
+
+    { # The response to upload an artifact.
+  "operation": { # This resource represents a long-running operation that is the result of a network API call. # Operation that will be returned to the user.
+    "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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html index d8386138694..faa7d16b002 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html @@ -116,6 +116,9 @@

Method Details

{ # An Workload object for managing highly regulated workloads of cloud customers. "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. + "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment." + "A String", + ], "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. @@ -217,6 +220,9 @@

Method Details

{ # An Workload object for managing highly regulated workloads of cloud customers. "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. + "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment." + "A String", + ], "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. @@ -276,6 +282,9 @@

Method Details

{ # An Workload object for managing highly regulated workloads of cloud customers. "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. + "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment." + "A String", + ], "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. @@ -340,6 +349,9 @@

Method Details

{ # An Workload object for managing highly regulated workloads of cloud customers. "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. + "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment." + "A String", + ], "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. @@ -387,6 +399,9 @@

Method Details

{ # An Workload object for managing highly regulated workloads of cloud customers. "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. + "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment." + "A String", + ], "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. diff --git a/docs/dyn/assuredworkloads_v1beta1.html b/docs/dyn/assuredworkloads_v1beta1.html new file mode 100644 index 00000000000..8765fd59760 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.html @@ -0,0 +1,116 @@ + + + +

Assured Workloads API

+

Instance Methods

+

+ organizations() +

+

Returns the organizations Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

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

Assured Workloads API . organizations

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html new file mode 100644 index 00000000000..3855859d45a --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html @@ -0,0 +1,96 @@ + + + +

Assured Workloads API . organizations . locations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ workloads() +

+

Returns the workloads Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.operations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.operations.html new file mode 100644 index 00000000000..a116bfb6ac0 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.operations.html @@ -0,0 +1,187 @@ + + + +

Assured Workloads API . organizations . locations . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

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

+

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

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ 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/assuredworkloads_v1beta1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html new file mode 100644 index 00000000000..dbe52dcb04a --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html @@ -0,0 +1,612 @@ + + + +

Assured Workloads API . organizations . locations . workloads

+

Instance Methods

+

+ organizations() +

+

Returns the organizations Resource.

+ +

+ violations() +

+

Returns the violations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, externalId=None, x__xgafv=None)

+

Creates Assured Workload.

+

+ delete(name, etag=None, x__xgafv=None)

+

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

+

+ get(name, x__xgafv=None)

+

Gets Assured Workload associated with a CRM Node

+

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

+

Lists Assured Workloads under a CRM Node.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

+

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

+

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, externalId=None, x__xgafv=None) +
Creates Assured Workload.
+
+Args:
+  parent: string, Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An Workload object for managing highly regulated workloads of cloud customers.
+  "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
+  "cjisSettings": { # Settings specific to resources needed for CJIS. # Input only. Immutable. Settings specific to resources needed for CJIS.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
+  "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
+  "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
+  "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
+  "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
+  "fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Input only. Immutable. Settings specific to resources needed for FedRAMP High.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "il4Settings": { # Settings specific to resources needed for IL4. # Input only. Immutable. Settings specific to resources needed for IL4.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
+  "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
+    "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+    "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+  },
+  "labels": { # Optional. Labels applied to the workload.
+    "a_key": "A String",
+  },
+  "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
+  "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
+  "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
+    { # Represent the custom settings for the resources to be created.
+      "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
+      "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
+    },
+  ],
+  "resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
+    { # Represent the resources that are children of this Workload.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_number.
+      "resourceType": "A String", # Indicates the type of resource.
+    },
+  ],
+  "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
+    "setupErrors": [ # Indicates SAA enrollment setup error if any.
+      "A String",
+    ],
+    "setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
+  },
+}
+
+  externalId: string, Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.
+  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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, x__xgafv=None) +
Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.
+
+Args:
+  name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required)
+  etag: string, Optional. The etag of the workload. If this is provided, it must match the server's etag.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets Assured Workload associated with a CRM Node
+
+Args:
+  name: string, Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Workload object for managing highly regulated workloads of cloud customers.
+  "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
+  "cjisSettings": { # Settings specific to resources needed for CJIS. # Required. Input only. Immutable. Settings specific to resources needed for CJIS.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
+  "complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
+    "acknowledgedViolationCount": 42, # Count of active Violations which are acknowledged in the Workload.
+    "activeViolationCount": 42, # Count of active Violations which haven't been acknowledged.
+  },
+  "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
+  "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
+  "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
+  "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
+  "fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "il4Settings": { # Settings specific to resources needed for IL4. # Required. Input only. Immutable. Settings specific to resources needed for IL4.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
+  "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
+    "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+    "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+  },
+  "labels": { # Optional. Labels applied to the workload.
+    "a_key": "A String",
+  },
+  "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
+  "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
+  "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
+    { # Represent the custom settings for the resources to be created.
+      "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
+      "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
+    },
+  ],
+  "resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
+    { # Represent the resources that are children of this Workload.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_number.
+      "resourceType": "A String", # Indicates the type of resource.
+    },
+  ],
+  "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
+    "setupErrors": [ # Indicates SAA enrollment setup error if any.
+      "A String",
+    ],
+    "setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Assured Workloads under a CRM Node.
+
+Args:
+  parent: string, Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`. (required)
+  filter: string, A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.
+  pageSize: integer, Page size.
+  pageToken: string, Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of ListWorkloads endpoint.
+  "nextPageToken": "A String", # The next page token. Return empty if reached the last page.
+  "workloads": [ # List of Workloads under a given parent.
+    { # An Workload object for managing highly regulated workloads of cloud customers.
+      "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
+      "cjisSettings": { # Settings specific to resources needed for CJIS. # Required. Input only. Immutable. Settings specific to resources needed for CJIS.
+        "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+          "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+          "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+        },
+      },
+      "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
+      "complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
+        "acknowledgedViolationCount": 42, # Count of active Violations which are acknowledged in the Workload.
+        "activeViolationCount": 42, # Count of active Violations which haven't been acknowledged.
+      },
+      "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
+        "A String",
+      ],
+      "createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
+      "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
+      "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
+      "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
+      "fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High.
+        "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+          "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+          "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+        },
+      },
+      "fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
+        "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+          "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+          "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+        },
+      },
+      "il4Settings": { # Settings specific to resources needed for IL4. # Required. Input only. Immutable. Settings specific to resources needed for IL4.
+        "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+          "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+          "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+        },
+      },
+      "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
+      "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
+        "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+        "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+      },
+      "labels": { # Optional. Labels applied to the workload.
+        "a_key": "A String",
+      },
+      "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
+      "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
+      "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
+        { # Represent the custom settings for the resources to be created.
+          "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
+          "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
+          "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
+        },
+      ],
+      "resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
+        { # Represent the resources that are children of this Workload.
+          "resourceId": "A String", # Resource identifier. For a project this represents project_number.
+          "resourceType": "A String", # Indicates the type of resource.
+        },
+      ],
+      "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
+        "setupErrors": [ # Indicates SAA enrollment setup error if any.
+          "A String",
+        ],
+        "setupStatus": "A String", # Indicates SAA enrollment status of a given 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.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
+
+Args:
+  name: string, Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An Workload object for managing highly regulated workloads of cloud customers.
+  "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
+  "cjisSettings": { # Settings specific to resources needed for CJIS. # Required. Input only. Immutable. Settings specific to resources needed for CJIS.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
+  "complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
+    "acknowledgedViolationCount": 42, # Count of active Violations which are acknowledged in the Workload.
+    "activeViolationCount": 42, # Count of active Violations which haven't been acknowledged.
+  },
+  "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
+  "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
+  "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
+  "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
+  "fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "il4Settings": { # Settings specific to resources needed for IL4. # Required. Input only. Immutable. Settings specific to resources needed for IL4.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
+  "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
+    "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+    "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+  },
+  "labels": { # Optional. Labels applied to the workload.
+    "a_key": "A String",
+  },
+  "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
+  "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
+  "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
+    { # Represent the custom settings for the resources to be created.
+      "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
+      "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
+    },
+  ],
+  "resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
+    { # Represent the resources that are children of this Workload.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_number.
+      "resourceType": "A String", # Indicates the type of resource.
+    },
+  ],
+  "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
+    "setupErrors": [ # Indicates SAA enrollment setup error if any.
+      "A String",
+    ],
+    "setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
+  },
+}
+
+  updateMask: string, Required. The list of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Workload object for managing highly regulated workloads of cloud customers.
+  "billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
+  "cjisSettings": { # Settings specific to resources needed for CJIS. # Required. Input only. Immutable. Settings specific to resources needed for CJIS.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
+  "complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
+    "acknowledgedViolationCount": 42, # Count of active Violations which are acknowledged in the Workload.
+    "activeViolationCount": 42, # Count of active Violations which haven't been acknowledged.
+  },
+  "compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
+  "displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
+  "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
+  "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
+  "fedrampHighSettings": { # Settings specific to resources needed for FedRAMP High. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "fedrampModerateSettings": { # Settings specific to resources needed for FedRAMP Moderate. # Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "il4Settings": { # Settings specific to resources needed for IL4. # Required. Input only. Immutable. Settings specific to resources needed for IL4.
+    "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Immutable. Settings used to create a CMEK crypto key.
+      "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+      "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+    },
+  },
+  "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
+  "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
+    "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
+    "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
+  },
+  "labels": { # Optional. Labels applied to the workload.
+    "a_key": "A String",
+  },
+  "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
+  "provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
+  "resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
+    { # Represent the custom settings for the resources to be created.
+      "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
+      "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
+    },
+  ],
+  "resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
+    { # Represent the resources that are children of this Workload.
+      "resourceId": "A String", # Resource identifier. For a project this represents project_number.
+      "resourceType": "A String", # Indicates the type of resource.
+    },
+  ],
+  "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
+    "setupErrors": [ # Indicates SAA enrollment setup error if any.
+      "A String",
+    ],
+    "setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
+  },
+}
+
+ +
+ restrictAllowedResources(name, body=None, x__xgafv=None) +
Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.
+
+Args:
+  name: string, Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for restricting list of available resources in Workload environment.
+  "restrictionType": "A String", # Required. The type of restriction for using gcp products in the Workload environment.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for restricting the list of allowed resources.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.html new file mode 100644 index 00000000000..a692f0bdbb1 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.html @@ -0,0 +1,91 @@ + + + +

Assured Workloads API . organizations . locations . workloads . organizations

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.html new file mode 100644 index 00000000000..5b530eb9c8f --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.html @@ -0,0 +1,91 @@ + + + +

Assured Workloads API . organizations . locations . workloads . organizations . locations

+

Instance Methods

+

+ workloads() +

+

Returns the workloads Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.workloads.html new file mode 100644 index 00000000000..8c6a59c792f --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.organizations.locations.workloads.html @@ -0,0 +1,112 @@ + + + +

Assured Workloads API . organizations . locations . workloads . organizations . locations . workloads

+

Instance Methods

+

+ analyzeWorkloadMove(source, target, project=None, x__xgafv=None)

+

Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ analyzeWorkloadMove(source, target, project=None, x__xgafv=None) +
Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.
+
+Args:
+  source: string, The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1" (required)
+  target: string, Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
+  project: string, The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response that includes the analysis of the hypothetical resource move.
+  "blockers": [ # A list of blockers that should be addressed before moving the source project or project-based workload to the destination folder-based workload.
+    "A String",
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html new file mode 100644 index 00000000000..13c18c0d91f --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html @@ -0,0 +1,175 @@ + + + +

Assured Workloads API . organizations . locations . workloads . violations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieves Assured Workload Violation based on ID.

+

+ list(parent, filter=None, interval_endTime=None, interval_startTime=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Retrieves Assured Workload Violation based on ID.
+
+Args:
+  name: string, Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Workload monitoring Violation.
+  "auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}
+  "beginTime": "A String", # Output only. Time of the event which triggered the Violation.
+  "category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
+  "description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
+  "name": "A String", # Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}
+  "nonCompliantOrgPolicy": "A String", # Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}
+  "orgPolicyConstraint": "A String", # Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.
+  "resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
+  "state": "A String", # Output only. State of the violation
+  "updateTime": "A String", # Output only. The last time when the Violation record was updated.
+}
+
+ +
+ list(parent, filter=None, interval_endTime=None, interval_startTime=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`
+
+Args:
+  parent: string, Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`. (required)
+  filter: string, Optional. A custom filter for filtering by the Violations properties.
+  interval_endTime: string, The end of the time window.
+  interval_startTime: string, The start of the time window.
+  pageSize: integer, Optional. Page size.
+  pageToken: string, Optional. Page token returned from previous request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of ListViolations endpoint.
+  "nextPageToken": "A String", # The next page token. Returns empty if reached the last page.
+  "violations": [ # List of Violations under a Workload.
+    { # Workload monitoring Violation.
+      "auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}
+      "beginTime": "A String", # Output only. Time of the event which triggered the Violation.
+      "category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
+      "description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
+      "name": "A String", # Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}
+      "nonCompliantOrgPolicy": "A String", # Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}
+      "orgPolicyConstraint": "A String", # Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.
+      "resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
+      "state": "A String", # Output only. State of the violation
+      "updateTime": "A String", # Output only. The last time when the Violation record was updated.
+    },
+  ],
+}
+
+ +
+ 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/assuredworkloads_v1beta1.projects.html b/docs/dyn/assuredworkloads_v1beta1.projects.html new file mode 100644 index 00000000000..9a64a43c32c --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.html @@ -0,0 +1,91 @@ + + + +

Assured Workloads API . projects

+

Instance Methods

+

+ organizations() +

+

Returns the organizations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.organizations.html b/docs/dyn/assuredworkloads_v1beta1.projects.organizations.html new file mode 100644 index 00000000000..30d1a8599bd --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.organizations.html @@ -0,0 +1,91 @@ + + + +

Assured Workloads API . projects . organizations

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.html b/docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.html new file mode 100644 index 00000000000..0d05518a3b3 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.html @@ -0,0 +1,91 @@ + + + +

Assured Workloads API . projects . organizations . locations

+

Instance Methods

+

+ workloads() +

+

Returns the workloads Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.workloads.html new file mode 100644 index 00000000000..76f7cc4b1c6 --- /dev/null +++ b/docs/dyn/assuredworkloads_v1beta1.projects.organizations.locations.workloads.html @@ -0,0 +1,112 @@ + + + +

Assured Workloads API . projects . organizations . locations . workloads

+

Instance Methods

+

+ analyzeWorkloadMove(project, target, source=None, x__xgafv=None)

+

Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ analyzeWorkloadMove(project, target, source=None, x__xgafv=None) +
Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.
+
+Args:
+  project: string, The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID. (required)
+  target: string, Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
+  source: string, The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1"
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response that includes the analysis of the hypothetical resource move.
+  "blockers": [ # A list of blockers that should be addressed before moving the source project or project-based workload to the destination folder-based workload.
+    "A String",
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html b/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html index ebf01dfe061..763a6c6c29f 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html @@ -300,7 +300,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -552,7 +552,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -594,7 +594,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html b/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html index b4fcac0b2a3..35f4eeab1a4 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html @@ -302,7 +302,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -570,7 +570,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -612,7 +612,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/beyondcorp_v1.projects.locations.appGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.appGateways.html index f6273218745..06581e2c0b8 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.appGateways.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.appGateways.html @@ -279,7 +279,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -384,7 +384,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -426,7 +426,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/beyondcorp_v1.projects.locations.clientConnectorServices.html b/docs/dyn/beyondcorp_v1.projects.locations.clientConnectorServices.html index ba4c35645c2..e66ae3a4137 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.clientConnectorServices.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.clientConnectorServices.html @@ -288,7 +288,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -462,7 +462,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -504,7 +504,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/beyondcorp_v1.projects.locations.clientGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.clientGateways.html index 59f13231818..d3ef4f4a851 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.clientGateways.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.clientGateways.html @@ -255,7 +255,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -348,7 +348,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -390,7 +390,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 97b274db02d..eb9b6b21d93 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -480,6 +480,9 @@

Method Details

"copied_rows": "A String", # [Output-only] Number of rows copied to the destination table. }, "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. + "dataMaskingStatistics": { # [Output-only] Statistics for data masking. Present only for query and extract jobs. + "dataMaskingApplied": false, # [Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where. + }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -1168,6 +1171,9 @@

Method Details

"copied_rows": "A String", # [Output-only] Number of rows copied to the destination table. }, "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. + "dataMaskingStatistics": { # [Output-only] Statistics for data masking. Present only for query and extract jobs. + "dataMaskingApplied": false, # [Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where. + }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -1927,6 +1933,9 @@

Method Details

"copied_rows": "A String", # [Output-only] Number of rows copied to the destination table. }, "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. + "dataMaskingStatistics": { # [Output-only] Statistics for data masking. Present only for query and extract jobs. + "dataMaskingApplied": false, # [Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where. + }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -2590,6 +2599,9 @@

Method Details

"copied_rows": "A String", # [Output-only] Number of rows copied to the destination table. }, "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. + "dataMaskingStatistics": { # [Output-only] Statistics for data masking. Present only for query and extract jobs. + "dataMaskingApplied": false, # [Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where. + }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -3281,6 +3293,9 @@

Method Details

"copied_rows": "A String", # [Output-only] Number of rows copied to the destination table. }, "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. + "dataMaskingStatistics": { # [Output-only] Statistics for data masking. Present only for query and extract jobs. + "dataMaskingApplied": false, # [Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where. + }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html index 4d64aca0c5d..d9fefdfab84 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html @@ -273,7 +273,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -442,7 +442,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -484,7 +484,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.html b/docs/dyn/bigtableadmin_v2.projects.instances.html index 3ba478b7948..613c96449c7 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.html @@ -296,7 +296,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -440,7 +440,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -482,7 +482,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index d128f7dd8e6..339be6db05c 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -470,7 +470,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -763,7 +763,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -805,7 +805,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index 15f433a92aa..fffdbb8d75f 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -83,6 +83,9 @@

Instance Methods

countChromeDevicesThatNeedAttention(customer, orgUnitId=None, readMask=None, x__xgafv=None)

Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947

+

+ countChromeHardwareFleetDevices(customer, orgUnitId=None, readMask=None, x__xgafv=None)

+

Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947

countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)

Generate report of installed Chrome versions.

@@ -162,6 +165,50 @@

Method Details

}
+
+ countChromeHardwareFleetDevices(customer, orgUnitId=None, readMask=None, x__xgafv=None) +
Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947
+
+Args:
+  customer: string, Required. The customer ID or "my_customer". (required)
+  orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned.
+  readMask: string, Required. Mask of the fields that should be populated in the returned report.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing a list of devices with a specific type of hardware specification from the requested hardware type.
+  "cpuReports": [ # The DeviceHardwareCountReport for device cpu type (for example Intel(R) Core(TM) i7-10610U CPU @ 1.80GHz).
+    { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
+      "bucket": "A String", # Public name of the hardware specification.
+      "count": "A String", # Count of devices with a unique hardware specification.
+    },
+  ],
+  "memoryReports": [ # The DeviceHardwareCountReport for device memory amount in gigabytes (for example 16).
+    { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
+      "bucket": "A String", # Public name of the hardware specification.
+      "count": "A String", # Count of devices with a unique hardware specification.
+    },
+  ],
+  "modelReports": [ # The DeviceHardwareCountReport for device model type (for example Acer C7 Chromebook).
+    { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
+      "bucket": "A String", # Public name of the hardware specification.
+      "count": "A String", # Count of devices with a unique hardware specification.
+    },
+  ],
+  "storageReports": [ # The DeviceHardwareCountReport for device storage amount in gigabytes (for example 128).
+    { # Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.
+      "bucket": "A String", # Public name of the hardware specification.
+      "count": "A String", # Count of devices with a unique hardware specification.
+    },
+  ],
+}
+
+
countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)
Generate report of installed Chrome versions.
diff --git a/docs/dyn/cloudbilling_v1beta.billingAccounts.html b/docs/dyn/cloudbilling_v1beta.billingAccounts.html
new file mode 100644
index 00000000000..43aea5330a6
--- /dev/null
+++ b/docs/dyn/cloudbilling_v1beta.billingAccounts.html
@@ -0,0 +1,447 @@
+
+
+
+

Cloud Billing API . billingAccounts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ estimateCostScenario(billingAccount, body=None, x__xgafv=None)

+

Use custom pricing in the estimate, using a `CostScenario` with a defined `billingAccount`.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ estimateCostScenario(billingAccount, body=None, x__xgafv=None) +
Use custom pricing in the estimate, using a `CostScenario` with a defined `billingAccount`.
+
+Args:
+  billingAccount: string, Resource name of the billing account for the cost estimate. The resource name has the form `billingAccounts/{billing_acount_id}`. For example, `billingAccounts/012345-567890-ABCDEF` is the resource name for billing account `012345-567890-ABCDEF`. Must be specified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for EstimateCostScenarioForBillingAccount.
+  "costScenario": { # Encapsulates all the information needed to perform a cost estimate. It includes a specification of the Google Cloud usage whose costs are estimated, and configuration options. # The scenario to estimate costs for.
+    "commitments": [ # New commitments to estimate the costs for. The cost of the commitments will be included in the estimate result and discounts the commitment entitles will be included in the workload cost estimates. A maximum of 100 workloads can be provided.
+      { # Commitments give you the ability to pay a recurring fee in exchange for a benefit, such as a discount for your use. For example, this object might contain details of a [spend-based committed use discount (CUD)](https://cloud.google.com/docs/cuds#spend_based_commitments). Within a CostScenario, adding a commitment includes the cost of the commitment and any discounts.
+        "name": "A String", # Required. A name for this commitment. All commitments in a CostScenario must have unique names. Each name must be a maximum of 32 characters.
+        "vmResourceBasedCud": { # Specifies a resource-based committed use discount (CUD). # A resource-based committed use discount (CUD).
+          "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerator, known as GPU.
+            "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance.
+            "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4".
+          },
+          "machineSeries": "A String", # The machine series for CUD. For example: "n1" for general purpose N1 machine type commitments. "n2" for general purpose N2 machine type commitments. "e2" for general purpose E2 machine type commitments. "n2d" for general purpose N2D machine type commitments. "t2d" for general purpose T2D machine type commitments. "c2"/"c2d" for compute-optimized commitments. "m1"/"m2" for the memory-optimized commitments. "a2' for the accelerator-optimized commitments.
+          "memorySizeGb": 3.14, # Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB).
+          "plan": "A String", # Commitment usage plan.
+          "region": "A String", # The region where the VM runs. For example: "us-central1"
+          "virtualCpuCount": "A String", # The number of vCPUs. The number of vCPUs must be an integer of 0 or more and can be even or odd.
+        },
+      },
+    ],
+    "scenarioConfig": { # Configuration for a CostScenario. Specifies how costs are calculated. # Configuration for the scenario.
+      "estimateDuration": "A String", # Time frame for the estimate. Workloads must specify usage for this duration. Duration must be at least 1 hour (3,600 seconds) and at most 10 years (315,360,000 seconds). The calculations for years and months are based on a 730-hour (2,628,000-second) month.
+    },
+    "workloads": [ # The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided.
+      { # Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed.
+        "cloudStorageWorkload": { # Specifies usage of Cloud Storage resources. # Usage on Google Cloud Storage.
+          "dataRetrieval": { # An amount of usage over a time frame. # Data retrieval usage. A retrieval cost applies when data or metadata is read, copied, or rewritten . For example: units such as "GiBy/s" or "By/s".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "dataStored": { # An amount of usage over a time frame. # Data storage usage. The amount of data stored in buckets. For example: units such as "GiBy/s" or "TBy/mo".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "dualRegion": { # Area contains dual locations. # Specify dual regions.
+            "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "asia1" for dual region.
+          },
+          "multiRegion": { # Area contains multiple locations. # Specify multi regions.
+            "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "us" for multi-region.
+          },
+          "operationA": { # An amount of usage over a time frame. # Class A operation usage in Cloud Storage, such as listing the objects in buckets. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "operationB": { # An amount of usage over a time frame. # Class B operation usage in Cloud Storage, such as `getIamPolicy`. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "region": { # Area contains only one location. # Specify a single region.
+            "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations). For example: "us-central1" for region.
+          },
+          "storageClass": "A String", # The [storage class](https://cloud.google.com/storage/docs/storage-classes#classes) of the data and operation. For example: "standard" or "nearline".
+        },
+        "computeVmWorkload": { # Specificies usage of a set of identical compute VM instances. # Usage of a Google Compute Engine Virtual Machine.
+          "enableConfidentialCompute": True or False, # Defines whether each instance has confidential compute enabled.
+          "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerators attached to each machine.
+            "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance.
+            "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4".
+          },
+          "instancesRunning": { # An amount of usage over a time frame. # VM usage. This is specified as a unitless quantity which indicates the number of instances running.
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "licenses": [ # Premium image licenses used by each instance.
+            "A String",
+          ],
+          "machineType": { # Specification of machine series, memory, and number of vCPUs. # The machine type.
+            "customMachineType": { # Specification of a custom machine type.
+              "machineSeries": "A String", # Required. The machine series. Only certain [machine series](https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types) support custom configurations. For example: "n1".
+              "memorySizeGb": 3.14, # Required. Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB). Each [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison) has limitations on allowed values for the ratio of memory-to-vCPU count.
+              "virtualCpuCount": "A String", # Required. The number of vCPUs. The allowed values depend on the [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison).
+            },
+            "predefinedMachineType": { # Specification of a predefined machine type.
+              "machineType": "A String", # The [machine type](https://cloud.google.com/compute/docs/machine-types). For example: "n1-standard1".
+            },
+          },
+          "persistentDisks": [ # Persistent disks attached to each instance. Must include a boot disk.
+            { # Specification of a persistent disk attached to a VM.
+              "diskSize": { # An amount of usage over a time frame. # Specifies the size of disk. Must be at least 10 GB.
+                "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+                  "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+                  "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                    { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                      "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                        "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                      },
+                      "usageRate": 3.14, # The usage rate.
+                    },
+                  ],
+                },
+              },
+              "diskType": "A String", # The [disk type](https://cloud.google.com/compute/docs/disks#disk-types). For example: "pd-standard".
+              "provisionedIops": { # An amount of usage over a time frame. # Indicates how many IOPS to provision for the disk for extreme persistent disks. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000.
+                "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+                  "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+                  "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                    { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                      "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                        "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                      },
+                      "usageRate": 3.14, # The usage rate.
+                    },
+                  ],
+                },
+              },
+              "scope": "A String", # The geographic scope of the disk. Defaults to `SCOPE_ZONAL` if not specified.
+            },
+          ],
+          "preemptible": True or False, # Defines whether each instance is preemptible.
+          "region": "A String", # The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: "us-central1".
+        },
+        "name": "A String", # Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` must be a maximum of 32 characters.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for EstimateCostScenarioForBillingAccount
+  "costEstimationResult": { # The result of a estimating the costs of a `CostScenario`. # The result of the cost estimation.
+    "currencyCode": "A String", # Required. The ISO 4217 currency code for the cost estimate.
+    "segmentCostEstimates": [ # Required. Estimated costs for each idealized month of a `CostScenario`.
+      { # Workload cost estimates for a single time segment.
+        "commitmentCostEstimates": [ # Estimated costs for each commitment.
+          { # Estimated cost for a commitment.
+            "commitmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the commitment.
+              "creditEstimates": [ # The estimated credits applied.
+                { # An estimated credit applied to the costs on a SKU.
+                  "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                    "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.
+                  },
+                  "creditDescription": "A String", # The credit description.
+                  "creditType": "A String", # The credit type.
+                },
+              ],
+              "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                "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.
+              },
+              "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                "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.
+              },
+            },
+            "name": "A String", # The name of the commitment, as specified in the `CostScenario`.
+            "skuCostEstimates": [ # Estimated costs for each SKU in the commitment.
+              { # Estimated cost for usage on a SKU.
+                "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU.
+                  "creditEstimates": [ # The estimated credits applied.
+                    { # An estimated credit applied to the costs on a SKU.
+                      "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                        "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.
+                      },
+                      "creditDescription": "A String", # The credit description.
+                      "creditType": "A String", # The credit type.
+                    },
+                  ],
+                  "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                    "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.
+                  },
+                  "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                    "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.
+                  },
+                },
+                "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.
+                "usageAmount": 3.14, # The amount of usage on this SKU.
+                "usageUnit": "A String", # The unit for the usage on this SKU.
+              },
+            ],
+          },
+        ],
+        "segmentStartTime": { # Represents a point in time. # Timestamp for the start of the segment.
+          "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+        },
+        "segmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the time segment.
+          "creditEstimates": [ # The estimated credits applied.
+            { # An estimated credit applied to the costs on a SKU.
+              "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                "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.
+              },
+              "creditDescription": "A String", # The credit description.
+              "creditType": "A String", # The credit type.
+            },
+          ],
+          "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+            "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.
+          },
+          "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+            "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.
+          },
+        },
+        "workloadCostEstimates": [ # Estimated costs for each workload.
+          { # Estimated cost for a workload.
+            "name": "A String", # The name of the workload, as specified in the `CostScenario`.
+            "skuCostEstimates": [ # Estimated costs for each SKU in the workload.
+              { # Estimated cost for usage on a SKU.
+                "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU.
+                  "creditEstimates": [ # The estimated credits applied.
+                    { # An estimated credit applied to the costs on a SKU.
+                      "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                        "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.
+                      },
+                      "creditDescription": "A String", # The credit description.
+                      "creditType": "A String", # The credit type.
+                    },
+                  ],
+                  "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                    "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.
+                  },
+                  "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                    "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.
+                  },
+                },
+                "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.
+                "usageAmount": 3.14, # The amount of usage on this SKU.
+                "usageUnit": "A String", # The unit for the usage on this SKU.
+              },
+            ],
+            "workloadTotalCostEstimate": { # An estimated cost. # Total estimated costs for the workload.
+              "creditEstimates": [ # The estimated credits applied.
+                { # An estimated credit applied to the costs on a SKU.
+                  "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                    "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.
+                  },
+                  "creditDescription": "A String", # The credit description.
+                  "creditType": "A String", # The credit type.
+                },
+              ],
+              "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                "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.
+              },
+              "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                "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.
+              },
+            },
+          },
+        ],
+      },
+    ],
+    "skus": [ # Required. Information about SKUs used in the estimate.
+      { # Information about SKUs appearing in the cost estimate.
+        "displayName": "A String", # The display name for the SKU. Example: A2 Instance Core running in Americas
+        "prices": [ # A timeline of prices for a SKU in chronological order. Note: The API currently only supports using a constant price for the entire estimation time frame so this list will contain a single value.
+          { # The price of a SKU at a point int time.
+            "effectiveTime": { # Represents a point in time. # The timestamp within the estimation time frame when the price was set.
+              "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+            },
+            "priceType": "A String", # The type of price. Possible values: "RATE"
+            "rate": { # A SKU price consisting of tiered rates. # A set of tiered rates.
+              "tiers": [ # The service tiers.
+                { # Pricing details for a service tier.
+                  "price": { # Represents an amount of money with its currency type. # The price for this tier.
+                    "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.
+                  },
+                  "startAmount": 3.14, # The magnitude of usage in which the tier interval begins. Example: "From 100 GiBi the price is $1 per byte" implies `start_amount` = 100
+                },
+              ],
+              "unit": "A String", # The SKU's pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this field will show 'By'. The `start_amount` field in each tier will be in this unit.
+              "unitCount": 3.14, # The SKU's count for the pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this column will show 1000000.
+            },
+          },
+        ],
+        "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudbilling_v1beta.html b/docs/dyn/cloudbilling_v1beta.html new file mode 100644 index 00000000000..94fda736d59 --- /dev/null +++ b/docs/dyn/cloudbilling_v1beta.html @@ -0,0 +1,116 @@ + + + +

Cloud Billing API

+

Instance Methods

+

+ billingAccounts() +

+

Returns the billingAccounts Resource.

+ +

+ v1beta() +

+

Returns the v1beta Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

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

Cloud Billing API . v1beta

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ estimateCostScenario(body=None, x__xgafv=None)

+

Estimate list prices using a `CostScenario` without a defined `billingAccount`.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ estimateCostScenario(body=None, x__xgafv=None) +
Estimate list prices using a `CostScenario` without a defined `billingAccount`.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for EstimateCostScenarioWithListPrice.
+  "costScenario": { # Encapsulates all the information needed to perform a cost estimate. It includes a specification of the Google Cloud usage whose costs are estimated, and configuration options. # The scenario to estimate costs for.
+    "commitments": [ # New commitments to estimate the costs for. The cost of the commitments will be included in the estimate result and discounts the commitment entitles will be included in the workload cost estimates. A maximum of 100 workloads can be provided.
+      { # Commitments give you the ability to pay a recurring fee in exchange for a benefit, such as a discount for your use. For example, this object might contain details of a [spend-based committed use discount (CUD)](https://cloud.google.com/docs/cuds#spend_based_commitments). Within a CostScenario, adding a commitment includes the cost of the commitment and any discounts.
+        "name": "A String", # Required. A name for this commitment. All commitments in a CostScenario must have unique names. Each name must be a maximum of 32 characters.
+        "vmResourceBasedCud": { # Specifies a resource-based committed use discount (CUD). # A resource-based committed use discount (CUD).
+          "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerator, known as GPU.
+            "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance.
+            "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4".
+          },
+          "machineSeries": "A String", # The machine series for CUD. For example: "n1" for general purpose N1 machine type commitments. "n2" for general purpose N2 machine type commitments. "e2" for general purpose E2 machine type commitments. "n2d" for general purpose N2D machine type commitments. "t2d" for general purpose T2D machine type commitments. "c2"/"c2d" for compute-optimized commitments. "m1"/"m2" for the memory-optimized commitments. "a2' for the accelerator-optimized commitments.
+          "memorySizeGb": 3.14, # Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB).
+          "plan": "A String", # Commitment usage plan.
+          "region": "A String", # The region where the VM runs. For example: "us-central1"
+          "virtualCpuCount": "A String", # The number of vCPUs. The number of vCPUs must be an integer of 0 or more and can be even or odd.
+        },
+      },
+    ],
+    "scenarioConfig": { # Configuration for a CostScenario. Specifies how costs are calculated. # Configuration for the scenario.
+      "estimateDuration": "A String", # Time frame for the estimate. Workloads must specify usage for this duration. Duration must be at least 1 hour (3,600 seconds) and at most 10 years (315,360,000 seconds). The calculations for years and months are based on a 730-hour (2,628,000-second) month.
+    },
+    "workloads": [ # The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided.
+      { # Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed.
+        "cloudStorageWorkload": { # Specifies usage of Cloud Storage resources. # Usage on Google Cloud Storage.
+          "dataRetrieval": { # An amount of usage over a time frame. # Data retrieval usage. A retrieval cost applies when data or metadata is read, copied, or rewritten . For example: units such as "GiBy/s" or "By/s".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "dataStored": { # An amount of usage over a time frame. # Data storage usage. The amount of data stored in buckets. For example: units such as "GiBy/s" or "TBy/mo".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "dualRegion": { # Area contains dual locations. # Specify dual regions.
+            "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "asia1" for dual region.
+          },
+          "multiRegion": { # Area contains multiple locations. # Specify multi regions.
+            "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "us" for multi-region.
+          },
+          "operationA": { # An amount of usage over a time frame. # Class A operation usage in Cloud Storage, such as listing the objects in buckets. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "operationB": { # An amount of usage over a time frame. # Class B operation usage in Cloud Storage, such as `getIamPolicy`. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s".
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "region": { # Area contains only one location. # Specify a single region.
+            "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations). For example: "us-central1" for region.
+          },
+          "storageClass": "A String", # The [storage class](https://cloud.google.com/storage/docs/storage-classes#classes) of the data and operation. For example: "standard" or "nearline".
+        },
+        "computeVmWorkload": { # Specificies usage of a set of identical compute VM instances. # Usage of a Google Compute Engine Virtual Machine.
+          "enableConfidentialCompute": True or False, # Defines whether each instance has confidential compute enabled.
+          "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerators attached to each machine.
+            "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance.
+            "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4".
+          },
+          "instancesRunning": { # An amount of usage over a time frame. # VM usage. This is specified as a unitless quantity which indicates the number of instances running.
+            "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+              "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+              "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                  "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                    "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                  },
+                  "usageRate": 3.14, # The usage rate.
+                },
+              ],
+            },
+          },
+          "licenses": [ # Premium image licenses used by each instance.
+            "A String",
+          ],
+          "machineType": { # Specification of machine series, memory, and number of vCPUs. # The machine type.
+            "customMachineType": { # Specification of a custom machine type.
+              "machineSeries": "A String", # Required. The machine series. Only certain [machine series](https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types) support custom configurations. For example: "n1".
+              "memorySizeGb": 3.14, # Required. Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB). Each [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison) has limitations on allowed values for the ratio of memory-to-vCPU count.
+              "virtualCpuCount": "A String", # Required. The number of vCPUs. The allowed values depend on the [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison).
+            },
+            "predefinedMachineType": { # Specification of a predefined machine type.
+              "machineType": "A String", # The [machine type](https://cloud.google.com/compute/docs/machine-types). For example: "n1-standard1".
+            },
+          },
+          "persistentDisks": [ # Persistent disks attached to each instance. Must include a boot disk.
+            { # Specification of a persistent disk attached to a VM.
+              "diskSize": { # An amount of usage over a time frame. # Specifies the size of disk. Must be at least 10 GB.
+                "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+                  "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+                  "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                    { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                      "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                        "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                      },
+                      "usageRate": 3.14, # The usage rate.
+                    },
+                  ],
+                },
+              },
+              "diskType": "A String", # The [disk type](https://cloud.google.com/compute/docs/disks#disk-types). For example: "pd-standard".
+              "provisionedIops": { # An amount of usage over a time frame. # Indicates how many IOPS to provision for the disk for extreme persistent disks. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000.
+                "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
+                  "unit": "A String", # The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
+                  "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
+                    { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
+                      "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
+                        "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+                      },
+                      "usageRate": 3.14, # The usage rate.
+                    },
+                  ],
+                },
+              },
+              "scope": "A String", # The geographic scope of the disk. Defaults to `SCOPE_ZONAL` if not specified.
+            },
+          ],
+          "preemptible": True or False, # Defines whether each instance is preemptible.
+          "region": "A String", # The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: "us-central1".
+        },
+        "name": "A String", # Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` must be a maximum of 32 characters.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for EstimateCostScenarioWithListPrice
+  "costEstimationResult": { # The result of a estimating the costs of a `CostScenario`. # The result of the cost estimation.
+    "currencyCode": "A String", # Required. The ISO 4217 currency code for the cost estimate.
+    "segmentCostEstimates": [ # Required. Estimated costs for each idealized month of a `CostScenario`.
+      { # Workload cost estimates for a single time segment.
+        "commitmentCostEstimates": [ # Estimated costs for each commitment.
+          { # Estimated cost for a commitment.
+            "commitmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the commitment.
+              "creditEstimates": [ # The estimated credits applied.
+                { # An estimated credit applied to the costs on a SKU.
+                  "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                    "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.
+                  },
+                  "creditDescription": "A String", # The credit description.
+                  "creditType": "A String", # The credit type.
+                },
+              ],
+              "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                "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.
+              },
+              "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                "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.
+              },
+            },
+            "name": "A String", # The name of the commitment, as specified in the `CostScenario`.
+            "skuCostEstimates": [ # Estimated costs for each SKU in the commitment.
+              { # Estimated cost for usage on a SKU.
+                "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU.
+                  "creditEstimates": [ # The estimated credits applied.
+                    { # An estimated credit applied to the costs on a SKU.
+                      "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                        "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.
+                      },
+                      "creditDescription": "A String", # The credit description.
+                      "creditType": "A String", # The credit type.
+                    },
+                  ],
+                  "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                    "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.
+                  },
+                  "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                    "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.
+                  },
+                },
+                "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.
+                "usageAmount": 3.14, # The amount of usage on this SKU.
+                "usageUnit": "A String", # The unit for the usage on this SKU.
+              },
+            ],
+          },
+        ],
+        "segmentStartTime": { # Represents a point in time. # Timestamp for the start of the segment.
+          "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+        },
+        "segmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the time segment.
+          "creditEstimates": [ # The estimated credits applied.
+            { # An estimated credit applied to the costs on a SKU.
+              "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                "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.
+              },
+              "creditDescription": "A String", # The credit description.
+              "creditType": "A String", # The credit type.
+            },
+          ],
+          "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+            "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.
+          },
+          "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+            "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.
+          },
+        },
+        "workloadCostEstimates": [ # Estimated costs for each workload.
+          { # Estimated cost for a workload.
+            "name": "A String", # The name of the workload, as specified in the `CostScenario`.
+            "skuCostEstimates": [ # Estimated costs for each SKU in the workload.
+              { # Estimated cost for usage on a SKU.
+                "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU.
+                  "creditEstimates": [ # The estimated credits applied.
+                    { # An estimated credit applied to the costs on a SKU.
+                      "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                        "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.
+                      },
+                      "creditDescription": "A String", # The credit description.
+                      "creditType": "A String", # The credit type.
+                    },
+                  ],
+                  "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                    "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.
+                  },
+                  "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                    "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.
+                  },
+                },
+                "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.
+                "usageAmount": 3.14, # The amount of usage on this SKU.
+                "usageUnit": "A String", # The unit for the usage on this SKU.
+              },
+            ],
+            "workloadTotalCostEstimate": { # An estimated cost. # Total estimated costs for the workload.
+              "creditEstimates": [ # The estimated credits applied.
+                { # An estimated credit applied to the costs on a SKU.
+                  "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
+                    "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.
+                  },
+                  "creditDescription": "A String", # The credit description.
+                  "creditType": "A String", # The credit type.
+                },
+              ],
+              "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
+                "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.
+              },
+              "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
+                "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.
+              },
+            },
+          },
+        ],
+      },
+    ],
+    "skus": [ # Required. Information about SKUs used in the estimate.
+      { # Information about SKUs appearing in the cost estimate.
+        "displayName": "A String", # The display name for the SKU. Example: A2 Instance Core running in Americas
+        "prices": [ # A timeline of prices for a SKU in chronological order. Note: The API currently only supports using a constant price for the entire estimation time frame so this list will contain a single value.
+          { # The price of a SKU at a point int time.
+            "effectiveTime": { # Represents a point in time. # The timestamp within the estimation time frame when the price was set.
+              "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
+            },
+            "priceType": "A String", # The type of price. Possible values: "RATE"
+            "rate": { # A SKU price consisting of tiered rates. # A set of tiered rates.
+              "tiers": [ # The service tiers.
+                { # Pricing details for a service tier.
+                  "price": { # Represents an amount of money with its currency type. # The price for this tier.
+                    "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.
+                  },
+                  "startAmount": 3.14, # The magnitude of usage in which the tier interval begins. Example: "From 100 GiBi the price is $1 per byte" implies `start_amount` = 100
+                },
+              ],
+              "unit": "A String", # The SKU's pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this field will show 'By'. The `start_amount` field in each tier will be in this unit.
+              "unitCount": 3.14, # The SKU's count for the pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this column will show 1000000.
+            },
+          },
+        ],
+        "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html index d2febcd01d3..7ce7e805b0b 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html @@ -154,6 +154,11 @@

Method Details

"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`. "A String", ], + "strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage. + "standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment. + "verify": True or False, # Whether to verify a deployment. + }, + }, "targetId": "A String", # The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. }, ], @@ -279,6 +284,11 @@

Method Details

"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`. "A String", ], + "strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage. + "standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment. + "verify": True or False, # Whether to verify a deployment. + }, + }, "targetId": "A String", # The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. }, ], @@ -387,6 +397,11 @@

Method Details

"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`. "A String", ], + "strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage. + "standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment. + "verify": True or False, # Whether to verify a deployment. + }, + }, "targetId": "A String", # The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. }, ], @@ -456,6 +471,11 @@

Method Details

"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`. "A String", ], + "strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage. + "standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment. + "verify": True or False, # Whether to verify a deployment. + }, + }, "targetId": "A String", # The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. }, ], diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html index 9cce4f689f2..91ceea1c2a2 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html @@ -178,6 +178,11 @@

Method Details

"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`. "A String", ], + "strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage. + "standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment. + "verify": True or False, # Whether to verify a deployment. + }, + }, "targetId": "A String", # The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. }, ], @@ -254,7 +259,7 @@

Method Details

"name": "A String", # Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. "requireApproval": True or False, # Optional. Whether or not the `Target` requires approval. "run": { # Information specifying where to deploy a Cloud Run Service. # Information specifying a Cloud Run deployment target. - "location": "A String", # Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`. + "location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`. }, "targetId": "A String", # Output only. Resource id of the `Target`. "uid": "A String", # Output only. Unique identifier of the `Target`. @@ -352,6 +357,11 @@

Method Details

"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`. "A String", ], + "strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage. + "standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment. + "verify": True or False, # Whether to verify a deployment. + }, + }, "targetId": "A String", # The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. }, ], @@ -428,7 +438,7 @@

Method Details

"name": "A String", # Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. "requireApproval": True or False, # Optional. Whether or not the `Target` requires approval. "run": { # Information specifying where to deploy a Cloud Run Service. # Information specifying a Cloud Run deployment target. - "location": "A String", # Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`. + "location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`. }, "targetId": "A String", # Output only. Resource id of the `Target`. "uid": "A String", # Output only. Unique identifier of the `Target`. @@ -502,6 +512,11 @@

Method Details

"profiles": [ # Skaffold profiles to use when rendering the manifest for this stage's `Target`. "A String", ], + "strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage. + "standard": { # Standard represents the standard deployment strategy. # Standard deployment strategy executes a single deploy and allows verifying the deployment. + "verify": True or False, # Whether to verify a deployment. + }, + }, "targetId": "A String", # The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. }, ], @@ -578,7 +593,7 @@

Method Details

"name": "A String", # Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. "requireApproval": True or False, # Optional. Whether or not the `Target` requires approval. "run": { # Information specifying where to deploy a Cloud Run Service. # Information specifying a Cloud Run deployment target. - "location": "A String", # Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`. + "location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`. }, "targetId": "A String", # Output only. Resource id of the `Target`. "uid": "A String", # Output only. Unique identifier of the `Target`. 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 11ffb835e44..8d88639bfb7 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html @@ -74,6 +74,11 @@

Google Cloud Deploy API . projects . locations . deliveryPipelines . releases . rollouts

Instance Methods

+

+ jobRuns() +

+

Returns the jobRuns Resource.

+

approve(name, body=None, x__xgafv=None)

Approves a Rollout.

@@ -92,6 +97,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ retryJob(rollout, body=None, x__xgafv=None)

+

Retries the specified Job in a Rollout.

Method Details

approve(name, body=None, x__xgafv=None) @@ -150,7 +158,7 @@

Method Details

"labels": { # Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, - "metadata": { # Metadata surfaces information associated with a `Rollout` to the user. # Output only. Metadata contains information about the rollout. + "metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout. "cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. "revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`. "service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is projects/{project}/locations/{location}/services/{service}. @@ -160,6 +168,32 @@

Method Details

}, }, "name": "A String", # Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. + "phases": [ # Output only. The phases that represent the workflows of this `Rollout`. + { # Phase represents a collection of jobs that are logically grouped together for a `Rollout`. + "deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition. + "deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the first job run in the phase. + "deployJob": { # A deploy Job. # Output only. A deploy Job. + }, + "id": "A String", # Output only. The ID of the Job. + "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job. + "state": "A String", # Output only. The current state of the Job. + "verifyJob": { # A verify Job. # Output only. A verify Job. + }, + }, + "verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds. + "deployJob": { # A deploy Job. # Output only. A deploy Job. + }, + "id": "A String", # Output only. The ID of the Job. + "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job. + "state": "A String", # Output only. The current state of the Job. + "verifyJob": { # A verify Job. # Output only. A verify Job. + }, + }, + }, + "id": "A String", # Output only. The ID of the Phase. + "state": "A String", # Output only. Current state of the Phase. + }, + ], "state": "A String", # Output only. Current state of the `Rollout`. "targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying. "uid": "A String", # Output only. Unique identifier of the `Rollout`. @@ -229,7 +263,7 @@

Method Details

"labels": { # Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, - "metadata": { # Metadata surfaces information associated with a `Rollout` to the user. # Output only. Metadata contains information about the rollout. + "metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout. "cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. "revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`. "service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is projects/{project}/locations/{location}/services/{service}. @@ -239,6 +273,32 @@

Method Details

}, }, "name": "A String", # Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. + "phases": [ # Output only. The phases that represent the workflows of this `Rollout`. + { # Phase represents a collection of jobs that are logically grouped together for a `Rollout`. + "deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition. + "deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the first job run in the phase. + "deployJob": { # A deploy Job. # Output only. A deploy Job. + }, + "id": "A String", # Output only. The ID of the Job. + "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job. + "state": "A String", # Output only. The current state of the Job. + "verifyJob": { # A verify Job. # Output only. A verify Job. + }, + }, + "verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds. + "deployJob": { # A deploy Job. # Output only. A deploy Job. + }, + "id": "A String", # Output only. The ID of the Job. + "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job. + "state": "A String", # Output only. The current state of the Job. + "verifyJob": { # A verify Job. # Output only. A verify Job. + }, + }, + }, + "id": "A String", # Output only. The ID of the Phase. + "state": "A String", # Output only. Current state of the Phase. + }, + ], "state": "A String", # Output only. Current state of the `Rollout`. "targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying. "uid": "A String", # Output only. Unique identifier of the `Rollout`. @@ -284,7 +344,7 @@

Method Details

"labels": { # Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, - "metadata": { # Metadata surfaces information associated with a `Rollout` to the user. # Output only. Metadata contains information about the rollout. + "metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout. "cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. "revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`. "service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is projects/{project}/locations/{location}/services/{service}. @@ -294,6 +354,32 @@

Method Details

}, }, "name": "A String", # Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. + "phases": [ # Output only. The phases that represent the workflows of this `Rollout`. + { # Phase represents a collection of jobs that are logically grouped together for a `Rollout`. + "deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition. + "deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the first job run in the phase. + "deployJob": { # A deploy Job. # Output only. A deploy Job. + }, + "id": "A String", # Output only. The ID of the Job. + "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job. + "state": "A String", # Output only. The current state of the Job. + "verifyJob": { # A verify Job. # Output only. A verify Job. + }, + }, + "verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds. + "deployJob": { # A deploy Job. # Output only. A deploy Job. + }, + "id": "A String", # Output only. The ID of the Job. + "jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job. + "state": "A String", # Output only. The current state of the Job. + "verifyJob": { # A verify Job. # Output only. A verify Job. + }, + }, + }, + "id": "A String", # Output only. The ID of the Phase. + "state": "A String", # Output only. Current state of the Phase. + }, + ], "state": "A String", # Output only. Current state of the `Rollout`. "targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying. "uid": "A String", # Output only. Unique identifier of the `Rollout`. @@ -319,4 +405,30 @@

Method Details

+
+ retryJob(rollout, body=None, x__xgafv=None) +
Retries the specified Job in a Rollout.
+
+Args:
+  rollout: string, Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RetryJobRequest is the request object used by `RetryJob`.
+  "jobId": "A String", # Required. The job ID for the Job to retry.
+  "phaseId": "A String", # Required. The phase ID the Job to retry belongs to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response object from 'RetryJob'.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html new file mode 100644 index 00000000000..9e5af616b4a --- /dev/null +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html @@ -0,0 +1,199 @@ + + + +

Google Cloud Deploy API . projects . locations . deliveryPipelines . releases . rollouts . jobRuns

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single JobRun.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists JobRuns in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single JobRun.
+
+Args:
+  name: string, Required. Name of the `JobRun`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A `JobRun` resource in the Google Cloud Deploy API. A `JobRun` contains information of a single `Rollout` job evaluation.
+  "createTime": "A String", # Output only. Time at which the `JobRun` was created.
+  "deployJobRun": { # DeployJobRun contains information specific to a deploy `JobRun`. # Output only. Information specific to a deploy `JobRun`.
+    "build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.
+    "failureCause": "A String", # Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.
+    "failureMessage": "A String", # Output only. Additional information about the deploy failure, if available.
+  },
+  "endTime": "A String", # Output only. Time at which the `JobRun` ended.
+  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "jobId": "A String", # Output only. ID of the `Rollout` job this `JobRun` corresponds to.
+  "name": "A String", # Optional. Name of the `JobRun`. Format is projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/ {rollouts}/jobRuns/{uuid}.
+  "phaseId": "A String", # Output only. ID of the `Rollout` phase this `JobRun` belongs in.
+  "startTime": "A String", # Output only. Time at which the `JobRun` was started.
+  "state": "A String", # Output only. The current state of the `JobRun`.
+  "uid": "A String", # Output only. Unique identifier of the `JobRun`.
+  "verifyJobRun": { # VerifyJobRun contains information specific to a verify `JobRun`. # Output only. Information specific to a verify `JobRun`.
+    "artifactUri": "A String", # Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.
+    "build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to verify. Format is projects/{project}/locations/{location}/builds/{build}.
+    "eventLogPath": "A String", # Output only. File path of the Skaffold event log relative to the artifact URI.
+    "failureCause": "A String", # Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded.
+    "failureMessage": "A String", # Output only. Additional information about the verify failure, if available.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists JobRuns in a given project and location.
+
+Args:
+  parent: string, Required. The `Rollout` which owns this collection of `JobRun` objects. (required)
+  filter: string, Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.
+  orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
+  pageSize: integer, Optional. The maximum number of `JobRun` objects to return. The service may return fewer than this value. If unspecified, at most 50 `JobRun` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListJobRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters 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:
+
+    { # ListJobRunsResponse is the response object returned by `ListJobRuns`.
+  "jobRuns": [ # The `JobRun` objects.
+    { # A `JobRun` resource in the Google Cloud Deploy API. A `JobRun` contains information of a single `Rollout` job evaluation.
+      "createTime": "A String", # Output only. Time at which the `JobRun` was created.
+      "deployJobRun": { # DeployJobRun contains information specific to a deploy `JobRun`. # Output only. Information specific to a deploy `JobRun`.
+        "build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.
+        "failureCause": "A String", # Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.
+        "failureMessage": "A String", # Output only. Additional information about the deploy failure, if available.
+      },
+      "endTime": "A String", # Output only. Time at which the `JobRun` ended.
+      "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "jobId": "A String", # Output only. ID of the `Rollout` job this `JobRun` corresponds to.
+      "name": "A String", # Optional. Name of the `JobRun`. Format is projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/ {rollouts}/jobRuns/{uuid}.
+      "phaseId": "A String", # Output only. ID of the `Rollout` phase this `JobRun` belongs in.
+      "startTime": "A String", # Output only. Time at which the `JobRun` was started.
+      "state": "A String", # Output only. The current state of the `JobRun`.
+      "uid": "A String", # Output only. Unique identifier of the `JobRun`.
+      "verifyJobRun": { # VerifyJobRun contains information specific to a verify `JobRun`. # Output only. Information specific to a verify `JobRun`.
+        "artifactUri": "A String", # Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.
+        "build": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to verify. Format is projects/{project}/locations/{location}/builds/{build}.
+        "eventLogPath": "A String", # Output only. File path of the Skaffold event log relative to the artifact URI.
+        "failureCause": "A String", # Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded.
+        "failureMessage": "A String", # Output only. Additional information about the verify failure, if available.
+      },
+    },
+  ],
+  "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": [ # Locations that could not be reached
+    "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/clouddeploy_v1.projects.locations.targets.html b/docs/dyn/clouddeploy_v1.projects.locations.targets.html index 910761132b9..0dec112193c 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.targets.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.targets.html @@ -159,7 +159,7 @@

Method Details

"name": "A String", # Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. "requireApproval": True or False, # Optional. Whether or not the `Target` requires approval. "run": { # Information specifying where to deploy a Cloud Run Service. # Information specifying a Cloud Run deployment target. - "location": "A String", # Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`. + "location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`. }, "targetId": "A String", # Output only. Resource id of the `Target`. "uid": "A String", # Output only. Unique identifier of the `Target`. @@ -291,7 +291,7 @@

Method Details

"name": "A String", # Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. "requireApproval": True or False, # Optional. Whether or not the `Target` requires approval. "run": { # Information specifying where to deploy a Cloud Run Service. # Information specifying a Cloud Run deployment target. - "location": "A String", # Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`. + "location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`. }, "targetId": "A String", # Output only. Resource id of the `Target`. "uid": "A String", # Output only. Unique identifier of the `Target`. @@ -408,7 +408,7 @@

Method Details

"name": "A String", # Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. "requireApproval": True or False, # Optional. Whether or not the `Target` requires approval. "run": { # Information specifying where to deploy a Cloud Run Service. # Information specifying a Cloud Run deployment target. - "location": "A String", # Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`. + "location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`. }, "targetId": "A String", # Output only. Resource id of the `Target`. "uid": "A String", # Output only. Unique identifier of the `Target`. @@ -484,7 +484,7 @@

Method Details

"name": "A String", # Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. "requireApproval": True or False, # Optional. Whether or not the `Target` requires approval. "run": { # Information specifying where to deploy a Cloud Run Service. # Information specifying a Cloud Run deployment target. - "location": "A String", # Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`. + "location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`. }, "targetId": "A String", # Output only. Resource id of the `Target`. "uid": "A String", # Output only. Unique identifier of the `Target`. diff --git a/docs/dyn/cloudresourcemanager_v3.projects.html b/docs/dyn/cloudresourcemanager_v3.projects.html index 96370829a7e..e1744bfe81a 100644 --- a/docs/dyn/cloudresourcemanager_v3.projects.html +++ b/docs/dyn/cloudresourcemanager_v3.projects.html @@ -109,7 +109,7 @@

Instance Methods

Retrieves the next page of results.

setIamPolicy(resource, body=None, x__xgafv=None)

-

Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. + Calling this method requires enabling the App Engine Admin API.

+

Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123..

@@ -496,7 +496,7 @@

Method Details

setIamPolicy(resource, body=None, x__xgafv=None) -
Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. + Calling this method requires enabling the App Engine Admin API.
+  
Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.
 
 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)
diff --git a/docs/dyn/cloudsupport_v2beta.cases.html b/docs/dyn/cloudsupport_v2beta.cases.html
index e4db74d636a..037f3b01579 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.html
@@ -462,7 +462,7 @@ 

Method Details

Args: pageSize: integer, The maximum number of cases fetched with each request. The default page size is 10. pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved. - query: string, An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. You must specify eitehr `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` retricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)` + query: string, An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify eitehr `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` retricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html index a9f026b713b..156723c01b1 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html @@ -78,8 +78,8 @@

Instance Methods

acknowledge(name, body=None, x__xgafv=None)

Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks.

- buffer(parent, taskId, body=None, x__xgafv=None)

-

Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer. Note: This feature is in its experimental stage. You must request access to the API through the [Cloud Tasks BufferTask Experiment Signup form](https://forms.gle/X8Zr5hiXH5tTGFqh8).

+ buffer(parent, body=None, x__xgafv=None)

+

Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. Note: This feature is in its experimental stage. You must request access to the API through the [Cloud Tasks BufferTasks Experiment Signup form](https://forms.gle/X8Zr5hiXH5tTGFqh8).

cancelLease(name, body=None, x__xgafv=None)

Cancel a pull task's lease. The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks.

@@ -137,17 +137,16 @@

Method Details

- buffer(parent, taskId, body=None, x__xgafv=None) -
Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer. Note: This feature is in its experimental stage. You must request access to the API through the [Cloud Tasks BufferTask Experiment Signup form](https://forms.gle/X8Zr5hiXH5tTGFqh8).
+    buffer(parent, body=None, x__xgafv=None)
+  
Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. Note: This feature is in its experimental stage. You must request access to the API through the [Cloud Tasks BufferTasks Experiment Signup form](https://forms.gle/X8Zr5hiXH5tTGFqh8).
 
 Args:
   parent: string, Required. The parent queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. (required)
-  taskId: string, Optional. Task ID for the task being created. If not provided, a random task ID is assigned to the task. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for BufferTask.
-  "body": { # 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. # Optional. Body of the HTTP request. The body can take any generic value. The value is written to the HttpRequest of the [Task].
+  "body": { # 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. # Optional. Body of the HTTP request. The body can take any generic value. The value will be written to the HttpRequest of the [Task].
     "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.
diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html
index 5955bc48079..e16b65cb6a8 100644
--- a/docs/dyn/connectors_v1.projects.locations.connections.html
+++ b/docs/dyn/connectors_v1.projects.locations.connections.html
@@ -480,7 +480,7 @@ 

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -810,7 +810,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -852,7 +852,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/connectors_v1.projects.locations.providers.html b/docs/dyn/connectors_v1.projects.locations.providers.html index 406742a6e00..0e2923af9cd 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.html @@ -173,7 +173,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -270,7 +270,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -312,7 +312,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 2a0872cc1a5..0a2b32d7c1a 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -289,7 +289,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -539,7 +539,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -665,7 +665,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1015,7 +1015,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -1265,7 +1265,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1391,7 +1391,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1644,7 +1644,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -1894,7 +1894,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -2020,7 +2020,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -3092,7 +3092,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index d04283be1f9..d16505de080 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -225,7 +225,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -544,7 +544,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -729,7 +729,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 071d4b1f890..8fa41513c05 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -393,7 +393,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -643,7 +643,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -769,7 +769,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1119,7 +1119,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -1369,7 +1369,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1495,7 +1495,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1792,7 +1792,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -2042,7 +2042,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -2168,7 +2168,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -3153,7 +3153,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index daa3b72ae45..7156c569c1a 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -290,7 +290,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -609,7 +609,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -794,7 +794,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 906f21233e0..a87f60b6a6e 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -299,7 +299,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -560,7 +560,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -568,7 +568,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -693,7 +693,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -701,7 +701,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1089,7 +1089,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1350,7 +1350,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -1358,7 +1358,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1483,7 +1483,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -1491,7 +1491,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1782,7 +1782,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -2043,7 +2043,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -2051,7 +2051,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -2176,7 +2176,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -2184,7 +2184,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -3304,7 +3304,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 74fdf0ccaba..ddc7a661990 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -222,7 +222,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -230,7 +230,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -552,7 +552,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -560,7 +560,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -748,7 +748,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -756,7 +756,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index bf8a435b711..8998e50dc41 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -413,7 +413,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -674,7 +674,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -682,7 +682,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -807,7 +807,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -815,7 +815,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1203,7 +1203,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1464,7 +1464,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -1472,7 +1472,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1597,7 +1597,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -1605,7 +1605,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -1940,7 +1940,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -2201,7 +2201,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -2209,7 +2209,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -2334,7 +2334,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -2342,7 +2342,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -3365,7 +3365,7 @@

Method Details

"description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index fc882b70159..a84e6075120 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -287,7 +287,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -295,7 +295,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -617,7 +617,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -625,7 +625,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], @@ -813,7 +813,7 @@

Method Details

"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", @@ -821,7 +821,7 @@

Method Details

"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. - "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. + "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). "A String", ], diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index cce48dfd4a5..d82b2a1ab5b 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.html @@ -90,7 +90,7 @@

Instance Methods

Returns the workItems Resource.

- aggregated(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+ aggregated(projectId, filter=None, location=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

List the jobs of a project across all regions.

aggregated_next()

@@ -108,7 +108,7 @@

Instance Methods

getMetrics(projectId, jobId, location=None, startTime=None, x__xgafv=None)

Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`.

- list(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+ list(projectId, filter=None, location=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`.

list_next()

@@ -121,7 +121,7 @@

Instance Methods

Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.

Method Details

- aggregated(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + aggregated(projectId, filter=None, location=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
List the jobs of a project across all regions.
 
 Args:
@@ -133,7 +133,6 @@ 

Method Details

TERMINATED - Filters the jobs that have a terminated state, ordered on the termination timestamp. Example terminated states: `JOB_STATE_STOPPED`, `JOB_STATE_UPDATED`, `JOB_STATE_DRAINED`, etc. ACTIVE - Filters the jobs that are running ordered on the creation timestamp. location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. - name: string, Optional. The job name. Optional. pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. view: string, Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. @@ -424,7 +423,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -757,7 +755,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -1074,7 +1071,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -1398,7 +1394,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -1477,7 +1472,7 @@

Method Details

- list(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(projectId, filter=None, location=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`.
 
 Args:
@@ -1489,7 +1484,6 @@ 

Method Details

TERMINATED - Filters the jobs that have a terminated state, ordered on the termination timestamp. Example terminated states: `JOB_STATE_STOPPED`, `JOB_STATE_UPDATED`, `JOB_STATE_DRAINED`, etc. ACTIVE - Filters the jobs that are running ordered on the creation timestamp. location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. - name: string, Optional. The job name. Optional. pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. view: string, Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. @@ -1780,7 +1774,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -2154,7 +2147,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -2464,7 +2456,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html index df0145b2c96..82e43c89063 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html @@ -479,7 +479,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html index cbaaf842ea0..ae92a6e109c 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html @@ -118,7 +118,7 @@

Instance Methods

getMetrics(projectId, location, jobId, startTime=None, x__xgafv=None)

Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`.

- list(projectId, location, filter=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+ list(projectId, location, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`.

list_next()

@@ -412,7 +412,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -728,7 +727,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -1052,7 +1050,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -1212,7 +1209,7 @@

Method Details

- list(projectId, location, filter=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(projectId, location, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`.
 
 Args:
@@ -1224,7 +1221,6 @@ 

Method Details

ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp. TERMINATED - Filters the jobs that have a terminated state, ordered on the termination timestamp. Example terminated states: `JOB_STATE_STOPPED`, `JOB_STATE_UPDATED`, `JOB_STATE_DRAINED`, etc. ACTIVE - Filters the jobs that are running ordered on the creation timestamp. - name: string, Optional. The job name. Optional. pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. view: string, Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. @@ -1515,7 +1511,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -1891,7 +1886,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -2200,7 +2194,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index 07a574b1744..1b586cc75c2 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -408,7 +408,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -839,7 +838,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index 39c4d26b4b8..4608ad5ce6b 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -407,7 +407,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. @@ -838,7 +837,6 @@

Method Details

], }, ], - "stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists. }, "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html index aacf5ac6171..955e056cf81 100644 --- a/docs/dyn/datastore_v1.projects.html +++ b/docs/dyn/datastore_v1.projects.html @@ -256,41 +256,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path. @@ -309,41 +275,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts. @@ -363,41 +295,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, }, @@ -624,41 +522,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -684,41 +548,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -821,7 +651,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -861,7 +709,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -924,7 +790,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1014,41 +898,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -1089,7 +939,25 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. diff --git a/docs/dyn/datastore_v1beta3.projects.html b/docs/dyn/datastore_v1beta3.projects.html index c3b557ac32e..11cb4313e7e 100644 --- a/docs/dyn/datastore_v1beta3.projects.html +++ b/docs/dyn/datastore_v1beta3.projects.html @@ -233,40 +233,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path. @@ -284,40 +251,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts. @@ -336,40 +270,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, }, @@ -485,40 +386,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -543,40 +411,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -676,7 +511,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -715,7 +567,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -776,7 +645,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -864,40 +750,7 @@

Method Details

], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -938,7 +791,24 @@

Method Details

"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. diff --git a/docs/dyn/deploymentmanager_alpha.deployments.html b/docs/dyn/deploymentmanager_alpha.deployments.html index 5ee0e1bc541..7b68d92ec42 100644 --- a/docs/dyn/deploymentmanager_alpha.deployments.html +++ b/docs/dyn/deploymentmanager_alpha.deployments.html @@ -417,7 +417,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -957,7 +957,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -986,7 +986,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -1027,7 +1027,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html index 1f7d314b904..834926a07a4 100644 --- a/docs/dyn/deploymentmanager_v2.deployments.html +++ b/docs/dyn/deploymentmanager_v2.deployments.html @@ -391,7 +391,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -851,7 +851,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -880,7 +880,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -921,7 +921,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/deploymentmanager_v2beta.deployments.html b/docs/dyn/deploymentmanager_v2beta.deployments.html index c450e9bfc8b..61266922495 100644 --- a/docs/dyn/deploymentmanager_v2beta.deployments.html +++ b/docs/dyn/deploymentmanager_v2beta.deployments.html @@ -391,7 +391,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -853,7 +853,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -882,7 +882,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -923,7 +923,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/displayvideo_v2.advertisers.assets.html b/docs/dyn/displayvideo_v2.advertisers.assets.html new file mode 100644 index 00000000000..838accc0525 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v2.advertisers.campaigns.html b/docs/dyn/displayvideo_v2.advertisers.campaigns.html new file mode 100644 index 00000000000..61022f990b0 --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.campaigns.html @@ -0,0 +1,986 @@ + + + +

Display & Video 360 API . advertisers . campaigns

+

Instance Methods

+

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ 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.

+

+ 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.

+

+ listAssignedTargetingOptions(advertiserId, campaignId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists assigned targeting options of a campaign across targeting types.

+

+ listAssignedTargetingOptions_next()

+

Retrieves the next page of 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 or insertion order. # 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.
+    "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, # 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
+    "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 or insertion order. # 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.
+    "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, # 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
+    "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.
+
+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 or insertion order. # 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.
+    "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, # 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
+    "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 properties. 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 operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. * 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.
+  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`.
+  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 or insertion order. # 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.
+        "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, # 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
+        "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.
+}
+
+ +
+ listAssignedTargetingOptions(advertiserId, campaignId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists assigned targeting options of a campaign across targeting types.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the campaign belongs to. (required)
+  campaignId: string, Required. The ID of the campaign to list assigned targeting options for. (required)
+  filter: string, Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_LANGUAGE or TARGETING_TYPE_GENDER `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * AssignedTargetingOptions 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.
+  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 `BulkListCampaignAssignedTargetingOptions` 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 BulkListCampaignAssignedTargetingOptions.
+  "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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListCampaignAssignedTargetingOptionsRequest 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, 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 or insertion order. # 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.
+    "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, # 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
+    "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 or insertion order. # 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.
+    "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, # 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
+    "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_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..f381c8b12bc --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,825 @@ + + + +

Display & Video 360 API . advertisers . campaigns . targetingTypes . assignedTargetingOptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(advertiserId, campaignId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Gets a single targeting option assigned to a campaign.

+

+ list(advertiserId, campaignId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the targeting options assigned to a campaign for a specified targeting type.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(advertiserId, campaignId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Gets a single targeting option assigned to a campaign.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the campaign belongs to. (required)
+  campaignId: string, Required. The ID of the campaign the assigned targeting option belongs to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `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_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `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.
+      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.
+  assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this campaign 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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ list(advertiserId, campaignId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the targeting options assigned to a campaign for a specified targeting type.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the campaign belongs to. (required)
+  campaignId: string, Required. The ID of the campaign to list assigned targeting options for. (required)
+  targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `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_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `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.
+      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.
+  filter: string, Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions 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.
+  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 `ListCampaignAssignedTargetingOptions` 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 ListCampaignAssignedTargetingOptions.
+  "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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListCampaignAssignedTargetingOptionsRequest 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_v2.advertisers.campaigns.targetingTypes.html b/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.html new file mode 100644 index 00000000000..60785d8938f --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.campaigns.targetingTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . advertisers . campaigns . 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_v2.advertisers.channels.html b/docs/dyn/displayvideo_v2.advertisers.channels.html new file mode 100644 index 00000000000..1c250207b95 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.
+  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 `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 `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_v2.advertisers.channels.sites.html b/docs/dyn/displayvideo_v2.advertisers.channels.sites.html new file mode 100644 index 00000000000..87db4ce2002 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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.

+

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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"`
+  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.
+
+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_v2.advertisers.creatives.html b/docs/dyn/displayvideo_v2.advertisers.creatives.html new file mode 100644 index 00000000000..bc7460498b0 --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.creatives.html @@ -0,0 +1,1127 @@ + + + +

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.

+

+ 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.

+

+ 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.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new creative. Returns the newly created creative if successful.
+
+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": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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.
+  "assets": [ # Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD`
+    { # Asset association for the creative.
+      "asset": { # A single asset. # 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.
+      },
+      "role": "A String", # 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` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+  },
+  "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`
+    "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.
+    { # 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_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_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", # 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.
+      "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, # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+      "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
+  },
+  "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.
+  },
+  "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.
+      },
+    ],
+    "publisherReviewStatuses": [ # Publisher review statuses for the creative.
+      { # Publisher review status for the creative.
+        "publisherName": "A String", # The publisher reviewing the creative.
+        "status": "A String", # Status of the publisher review.
+      },
+    ],
+  },
+  "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.
+  },
+  "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`
+  "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`
+    { # 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
+    },
+  ],
+  "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.
+    { # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`
+    { # 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.
+        "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.
+    },
+  ],
+  "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.
+  },
+  "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": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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.
+  "assets": [ # Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD`
+    { # Asset association for the creative.
+      "asset": { # A single asset. # 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.
+      },
+      "role": "A String", # 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` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+  },
+  "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`
+    "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.
+    { # 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_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_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", # 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.
+      "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, # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+      "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
+  },
+  "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.
+  },
+  "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.
+      },
+    ],
+    "publisherReviewStatuses": [ # Publisher review statuses for the creative.
+      { # Publisher review status for the creative.
+        "publisherName": "A String", # The publisher reviewing the creative.
+        "status": "A String", # Status of the publisher review.
+      },
+    ],
+  },
+  "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.
+  },
+  "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`
+  "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`
+    { # 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
+    },
+  ],
+  "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.
+    { # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`
+    { # 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.
+        "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.
+    },
+  ],
+  "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.
+  },
+  "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.
+
+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": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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.
+  "assets": [ # Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD`
+    { # Asset association for the creative.
+      "asset": { # A single asset. # 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.
+      },
+      "role": "A String", # 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` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+  },
+  "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`
+    "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.
+    { # 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_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_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", # 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.
+      "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, # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+      "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
+  },
+  "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.
+  },
+  "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.
+      },
+    ],
+    "publisherReviewStatuses": [ # Publisher review statuses for the creative.
+      { # Publisher review status for the creative.
+        "publisherName": "A String", # The publisher reviewing the creative.
+        "status": "A String", # Status of the publisher review.
+      },
+    ],
+  },
+  "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.
+  },
+  "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`
+  "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`
+    { # 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
+    },
+  ],
+  "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.
+    { # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`
+    { # 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.
+        "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.
+    },
+  ],
+  "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.
+  },
+  "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 properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)` for the following fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `creativeId` * The operator must be `HAS (:)` for the following fields: - `lineItemIds` * The operator must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` for the following fields: - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic`, there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. * 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). * There may be multiple `lineItemIds` restrictions in order to search against multiple possible line item IDs. * There may be multiple `creativeId` restrictions in order to search against multiple possible creative IDs. 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.
+  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 `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 `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": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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.
+      "assets": [ # Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD`
+        { # Asset association for the creative.
+          "asset": { # A single asset. # 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.
+          },
+          "role": "A String", # 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` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+      },
+      "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`
+        "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.
+        { # 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_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_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", # 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.
+          "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, # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+          "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
+      },
+      "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.
+      },
+      "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.
+          },
+        ],
+        "publisherReviewStatuses": [ # Publisher review statuses for the creative.
+          { # Publisher review status for the creative.
+            "publisherName": "A String", # The publisher reviewing the creative.
+            "status": "A String", # Status of the publisher review.
+          },
+        ],
+      },
+      "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.
+      },
+      "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`
+      "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`
+        { # 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
+        },
+      ],
+      "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.
+        { # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`
+        { # 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.
+            "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.
+        },
+      ],
+      "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.
+      },
+      "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.
+
+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": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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.
+  "assets": [ # Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD`
+    { # Asset association for the creative.
+      "asset": { # A single asset. # 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.
+      },
+      "role": "A String", # 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` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+  },
+  "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`
+    "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.
+    { # 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_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_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", # 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.
+      "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, # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+      "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
+  },
+  "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.
+  },
+  "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.
+      },
+    ],
+    "publisherReviewStatuses": [ # Publisher review statuses for the creative.
+      { # Publisher review status for the creative.
+        "publisherName": "A String", # The publisher reviewing the creative.
+        "status": "A String", # Status of the publisher review.
+      },
+    ],
+  },
+  "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.
+  },
+  "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`
+  "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`
+    { # 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
+    },
+  ],
+  "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.
+    { # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`
+    { # 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.
+        "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.
+    },
+  ],
+  "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.
+  },
+  "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": [ # Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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.
+  "assets": [ # Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD`
+    { # Asset association for the creative.
+      "asset": { # A single asset. # 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.
+      },
+      "role": "A String", # 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` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+  },
+  "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`
+    "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.
+    { # 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_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_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", # 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.
+      "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, # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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.
+      "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
+  },
+  "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.
+  },
+  "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.
+      },
+    ],
+    "publisherReviewStatuses": [ # Publisher review statuses for the creative.
+      { # Publisher review status for the creative.
+        "publisherName": "A String", # The publisher reviewing the creative.
+        "status": "A String", # Status of the publisher review.
+      },
+    ],
+  },
+  "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.
+  },
+  "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`
+  "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`
+    { # 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
+    },
+  ],
+  "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.
+    { # 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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`
+    { # 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.
+        "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.
+    },
+  ],
+  "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.
+  },
+  "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_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html new file mode 100644 index 00000000000..fc866b8fc07 --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.html @@ -0,0 +1,1561 @@ + + + +

Display & Video 360 API . advertisers

+

Instance Methods

+

+ 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.

+ +

+ manualTriggers() +

+

Returns the manualTriggers 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 can take up to 180 seconds to complete.

+

+ 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 can take up to 180 seconds to complete.
+
+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.
+      "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.
+  "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 use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
+    "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.
+      "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.
+  "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 use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
+    "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`
+    { # 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", # 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. Output only in v1. Required in v2.
+          },
+          "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.
+          "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. # 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.
+                { # 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.
+                },
+              ],
+            },
+            "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.
+                { # 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.
+                { # 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.
+                { # 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.
+              { # 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.
+                  { # 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.
+                  },
+                ],
+              },
+            ],
+            "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.
+                { # 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", # The audio content type. Output only in v1. Required in v2.
+          },
+          "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+          },
+          "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", # The content outstream position. Output only in v1. Required in v2.
+          },
+          "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", # The display name of the device type. Output only in v1. Required in v2.
+            "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", # The serving environment. Output only in v1. Required in v2.
+          },
+          "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. Output only in v1. Required in v2.
+          },
+          "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", # The gender of the audience. Output only in v1. Required in v2.
+          },
+          "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", # The household income of the audience. Output only in v1. Required in v2.
+          },
+          "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", # The content position. Output only in v1. Required in v2.
+          },
+          "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+          },
+          "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", # The parental status of the audience. Output only in v1. Required in v2.
+          },
+          "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 SearchTargetingOptions. 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".
+          },
+          "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.
+          },
+          "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 settings. # Third party brand verifier -- Adloox.
+              "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+                "A String",
+              ],
+            },
+            "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`, 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**.
+              "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", # The video player size. Output only in v1. Required in v2.
+          },
+          "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+          },
+        },
+      ],
+      "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`
+    { # 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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+}
+
+ +
+ 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.
+      "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.
+  "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 use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
+    "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 properties. 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 operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. * 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.
+  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 `100`. 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.
+          "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.
+      "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 use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
+        "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 properties. 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}`. * The operator must be `EQUALS (=)`. * 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.
+  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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "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.
+      "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.
+  "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 use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
+    "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.
+      "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.
+  "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 use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.
+    "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_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html new file mode 100644 index 00000000000..dca58bd2c8b --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html @@ -0,0 +1,1064 @@ + + + +

Display & Video 360 API . advertisers . insertionOrders

+

Instance Methods

+

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ 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.

+

+ listAssignedTargetingOptions(advertiserId, insertionOrderId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists assigned targeting options of an insertion order across targeting types.

+

+ listAssignedTargetingOptions_next()

+

Retrieves the next page of 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. # 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`.
+      "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`.
+      "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`.
+    },
+  },
+  "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order.
+  "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`.
+    "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.
+        "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", # 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 with a length of no more than 80 characters.
+      },
+    ],
+    "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.
+    "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, # 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
+    "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.
+    "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 insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+    "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 auto_budget_allocation, 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.
+  },
+  "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.
+    { # 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.
+    },
+  ],
+  "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
+    "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.
+  },
+  "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. # 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`.
+      "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`.
+      "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`.
+    },
+  },
+  "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order.
+  "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`.
+    "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.
+        "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", # 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 with a length of no more than 80 characters.
+      },
+    ],
+    "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.
+    "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, # 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
+    "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.
+    "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 insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+    "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 auto_budget_allocation, 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.
+  },
+  "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.
+    { # 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.
+    },
+  ],
+  "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
+    "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.
+  },
+  "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. # 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`.
+      "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`.
+      "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`.
+    },
+  },
+  "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order.
+  "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`.
+    "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.
+        "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", # 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 with a length of no more than 80 characters.
+      },
+    ],
+    "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.
+    "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, # 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
+    "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.
+    "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 insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+    "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 auto_budget_allocation, 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.
+  },
+  "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.
+    { # 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.
+    },
+  ],
+  "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
+    "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.
+  },
+  "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 properties. 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 operator used on `budget.budget_segments.date_range.end_date` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `entityStatus` - `budget.budget_segments.date_range.end_date` (input as YYYY-MM-DD) - `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 whose budget segments' dates end before March 28, 2019: `budget.budget_segments.date_range.end_date<"2019-03-28"` * 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.
+  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. # 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`.
+          "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`.
+          "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`.
+        },
+      },
+      "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order.
+      "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`.
+        "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.
+            "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", # 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 with a length of no more than 80 characters.
+          },
+        ],
+        "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.
+        "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, # 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
+        "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.
+        "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 insertion order.
+      "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+        "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 auto_budget_allocation, 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.
+      },
+      "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.
+        { # 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.
+        },
+      ],
+      "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
+        "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.
+      },
+      "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.
+}
+
+ +
+ listAssignedTargetingOptions(advertiserId, insertionOrderId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists assigned targeting options of an insertion order across targeting types.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the insertion order belongs to. (required)
+  insertionOrderId: string, Required. The ID of the insertion order to list assigned targeting options for. (required)
+  filter: string, Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions 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.
+  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 `BulkListInsertionOrderAssignedTargetingOptions` 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 BulkListInsertionOrderAssignedTargetingOptions.
+  "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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListInsertionOrderAssignedTargetingOptionsRequest 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, 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. # 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`.
+      "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`.
+      "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`.
+    },
+  },
+  "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order.
+  "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`.
+    "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.
+        "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", # 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 with a length of no more than 80 characters.
+      },
+    ],
+    "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.
+    "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, # 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
+    "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.
+    "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 insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+    "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 auto_budget_allocation, 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.
+  },
+  "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.
+    { # 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.
+    },
+  ],
+  "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
+    "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.
+  },
+  "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. # 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`.
+      "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`.
+      "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`.
+    },
+  },
+  "billableOutcome": "A String", # Immutable. The billable outcome of the insertion order.
+  "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`.
+    "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.
+        "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", # 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 with a length of no more than 80 characters.
+      },
+    ],
+    "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.
+    "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, # 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
+    "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.
+    "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 insertion order.
+  "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+    "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 auto_budget_allocation, 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.
+  },
+  "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.
+    { # 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.
+    },
+  ],
+  "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
+    "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.
+  },
+  "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_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..35b94b7ca14 --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,825 @@ + + + +

Display & Video 360 API . advertisers . insertionOrders . targetingTypes . assignedTargetingOptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(advertiserId, insertionOrderId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Gets a single targeting option assigned to an insertion order.

+

+ list(advertiserId, insertionOrderId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the targeting options assigned to an insertion order.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(advertiserId, insertionOrderId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Gets a single targeting option assigned to an insertion order.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the insertion order belongs to. (required)
+  insertionOrderId: string, Required. The ID of the insertion order the assigned targeting option belongs to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. (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.
+      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.
+  assignedTargetingOptionId: string, Required. An identifier unique to the targeting type in this insertion order 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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ list(advertiserId, insertionOrderId, targetingType, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the targeting options assigned to an insertion order.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the insertion order belongs to. (required)
+  insertionOrderId: string, Required. The ID of the insertion order to list assigned targeting options for. (required)
+  targetingType: string, Required. Identifies the type of assigned targeting options to list. (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.
+      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.
+  filter: string, Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions 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.
+  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 `ListInsertionOrderAssignedTargetingOptions` 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 ListInsertionOrderAssignedTargetingOptions.
+  "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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListInsertionOrderAssignedTargetingOptionsRequest 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_v2.advertisers.insertionOrders.targetingTypes.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.html new file mode 100644 index 00000000000..1d74d687124 --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.targetingTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . advertisers . insertionOrders . 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_v2.advertisers.invoices.html b/docs/dyn/displayvideo_v2.advertisers.invoices.html new file mode 100644 index 00000000000..460656d349f --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 `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 `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_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html new file mode 100644 index 00000000000..d652510169a --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -0,0 +1,2206 @@ + + + +

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 .

+

+ 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(advertisersId, body=None, x__xgafv=None)

+

Updates multiple line items.

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new line item. Returns the newly created line item if successful.

+

+ 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.

+

+ 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

+

+ 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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption

+

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 .
+
+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.
+    { # 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", # 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. Output only in v1. Required in v2.
+          },
+          "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.
+          "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. # 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.
+                { # 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.
+                },
+              ],
+            },
+            "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.
+                { # 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.
+                { # 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.
+                { # 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.
+              { # 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.
+                  { # 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.
+                  },
+                ],
+              },
+            ],
+            "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.
+                { # 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", # The audio content type. Output only in v1. Required in v2.
+          },
+          "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+          },
+          "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", # The content outstream position. Output only in v1. Required in v2.
+          },
+          "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", # The display name of the device type. Output only in v1. Required in v2.
+            "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", # The serving environment. Output only in v1. Required in v2.
+          },
+          "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. Output only in v1. Required in v2.
+          },
+          "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", # The gender of the audience. Output only in v1. Required in v2.
+          },
+          "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", # The household income of the audience. Output only in v1. Required in v2.
+          },
+          "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", # The content position. Output only in v1. Required in v2.
+          },
+          "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+          },
+          "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", # The parental status of the audience. Output only in v1. Required in v2.
+          },
+          "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 SearchTargetingOptions. 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".
+          },
+          "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.
+          },
+          "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 settings. # Third party brand verifier -- Adloox.
+              "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+                "A String",
+              ],
+            },
+            "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`, 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**.
+              "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", # The video player size. Output only in v1. Required in v2.
+          },
+          "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+          },
+        },
+      ],
+      "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.
+    { # 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 properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions 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.
+  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", # 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. Output only in v1. Required in v2.
+        },
+        "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.
+        "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. # 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.
+              { # 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.
+              },
+            ],
+          },
+          "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.
+              { # 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.
+              { # 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.
+              { # 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.
+            { # 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.
+                { # 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.
+                },
+              ],
+            },
+          ],
+          "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.
+              { # 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", # The audio content type. Output only in v1. Required in v2.
+        },
+        "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+        },
+        "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", # The content outstream position. Output only in v1. Required in v2.
+        },
+        "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", # The display name of the device type. Output only in v1. Required in v2.
+          "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", # The serving environment. Output only in v1. Required in v2.
+        },
+        "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. Output only in v1. Required in v2.
+        },
+        "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", # The gender of the audience. Output only in v1. Required in v2.
+        },
+        "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", # The household income of the audience. Output only in v1. Required in v2.
+        },
+        "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", # The content position. Output only in v1. Required in v2.
+        },
+        "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+        },
+        "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", # The parental status of the audience. Output only in v1. Required in v2.
+        },
+        "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 SearchTargetingOptions. 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".
+        },
+        "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.
+        },
+        "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 settings. # Third party brand verifier -- Adloox.
+            "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+              "A String",
+            ],
+          },
+          "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`, 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**.
+            "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", # The video player size. Output only in v1. Required in v2.
+        },
+        "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+        },
+      },
+      "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(advertisersId, body=None, x__xgafv=None) +
Updates multiple line items.
+
+Args:
+  advertisersId: string, A parameter (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`.
+        "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`.
+        "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`.
+      },
+    },
+    "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.
+      "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.
+        { # 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.
+      "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, # 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
+      "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 auto_budget_allocation, 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.
+    },
+    "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+      "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+      "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+    },
+    "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.
+      "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+        "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` 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` If not using an applicable strategy, the value of this field will be 0.
+      },
+      "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+      "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.
+        "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+        "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.
+        "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+      },
+      "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+        "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+          },
+        ],
+      },
+      "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.
+        "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, # 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
+        "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.
+
+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`.
+      "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`.
+      "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`.
+    },
+  },
+  "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.
+    "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.
+      { # 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.
+    "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, # 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
+    "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 auto_budget_allocation, 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.
+  },
+  "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+    "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+    "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+  },
+  "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.
+    "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+      "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` 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` If not using an applicable strategy, the value of this field will be 0.
+    },
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "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.
+      "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+      "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.
+      "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+    },
+    "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+      "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+        },
+      ],
+    },
+    "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.
+      "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, # 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
+      "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`.
+      "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`.
+      "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`.
+    },
+  },
+  "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.
+    "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.
+      { # 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.
+    "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, # 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
+    "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 auto_budget_allocation, 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.
+  },
+  "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+    "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+    "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+  },
+  "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.
+    "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+      "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` 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` If not using an applicable strategy, the value of this field will be 0.
+    },
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "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.
+      "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+      "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.
+      "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+    },
+    "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+      "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+        },
+      ],
+    },
+    "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.
+      "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, # 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
+      "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.
+
+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); }
+}
+
+ +
+ 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
+
+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`.
+      "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`.
+      "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`.
+    },
+  },
+  "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.
+    "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.
+      { # 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.
+    "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, # 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
+    "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 auto_budget_allocation, 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.
+  },
+  "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+    "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+    "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+  },
+  "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.
+    "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+      "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` 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` If not using an applicable strategy, the value of this field will be 0.
+    },
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "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.
+      "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+      "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.
+      "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+    },
+    "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+      "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+        },
+      ],
+    },
+    "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.
+      "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, # 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
+      "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`.
+      "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`.
+      "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`.
+    },
+  },
+  "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.
+    "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.
+      { # 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.
+    "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, # 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
+    "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 auto_budget_allocation, 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.
+  },
+  "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+    "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+    "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+  },
+  "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.
+    "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+      "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` 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` If not using an applicable strategy, the value of this field will be 0.
+    },
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "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.
+      "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+      "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.
+      "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+    },
+    "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+      "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+        },
+      ],
+    },
+    "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.
+      "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, # 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
+      "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 properties. 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 operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported properties: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - `targetedChannelId` - `targetedNegativeKeywordListId` 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 whose flight dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:"NO_VALID_CREATIVE"` * 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"` * All line items that are using both the specified channel and specified negative keyword list in their targeting: `targetedNegativeKeywordListId=789 AND targetedChannelId=12345` The length of this field should be no more than 500 characters.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `flight.dateRange.endDate` * `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 `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`.
+          "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`.
+          "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`.
+        },
+      },
+      "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.
+        "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.
+          { # 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.
+        "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, # 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
+        "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 auto_budget_allocation, 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.
+      },
+      "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+        "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+        "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+      },
+      "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.
+        "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+          "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` 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` If not using an applicable strategy, the value of this field will be 0.
+        },
+        "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+        "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.
+          "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+          "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.
+          "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+        },
+        "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+          "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+            },
+          ],
+        },
+        "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.
+          "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, # 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
+          "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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption
+
+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`.
+      "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`.
+      "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`.
+    },
+  },
+  "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.
+    "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.
+      { # 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.
+    "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, # 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
+    "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 auto_budget_allocation, 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.
+  },
+  "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+    "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+    "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+  },
+  "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.
+    "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+      "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` 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` If not using an applicable strategy, the value of this field will be 0.
+    },
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "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.
+      "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+      "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.
+      "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+    },
+    "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+      "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+        },
+      ],
+    },
+    "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.
+      "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, # 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
+      "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`.
+      "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`.
+      "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`.
+    },
+  },
+  "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.
+    "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.
+      { # 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.
+    "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, # 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
+    "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 auto_budget_allocation, 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.
+  },
+  "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 targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item.
+    "excludeFirstPartyAudience": True or False, # Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.
+    "targetingExpansionLevel": "A String", # Required. Magnitude of expansion for applicable targeting under this line item.
+  },
+  "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.
+    "biddingStrategy": { # Settings that control the bid strategy for YouTube and Partners resources. # The bidding strategy of the YouTube and Partners line item.
+      "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` 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` If not using an applicable strategy, the value of this field will be 0.
+    },
+    "contentCategory": "A String", # The kind of content on which the YouTube and Partners ads will be shown.
+    "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.
+      "includeYoutubeSearch": True or False, # Whether to target inventory on the YouTube search results page.
+      "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.
+      "includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.
+    },
+    "thirdPartyMeasurementSettings": { # Settings that control what third-party vendors are measuring specific line item metrics. # The third-party measurement settings of the line item.
+      "brandLiftVendorConfigs": [ # 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": [ # 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": [ # 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": [ # 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.
+        },
+      ],
+    },
+    "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.
+      "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, # 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
+      "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_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..20a21dab49e --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,1544 @@ + + + +

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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption

+

+ 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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption

+

+ 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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption
+
+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. (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.
+      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.
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ 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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption
+
+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. (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.
+      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.
+  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. (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.
+      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.
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ 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. (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.
+      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.
+  filter: string, Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions 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.
+  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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "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_v2.advertisers.lineItems.targetingTypes.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.html new file mode 100644 index 00000000000..590956d4338 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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_v2.advertisers.locationLists.assignedLocations.html b/docs/dyn/displayvideo_v2.advertisers.locationLists.assignedLocations.html new file mode 100644 index 00000000000..6896ca01350 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.

+

+ 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 BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.
+
+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 AssignedLocations.
+    { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
+      "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. Must be of type TARGETING_TYPE_GEO_REGION.
+    },
+  ],
+  "deletedAssignedLocations": [ # The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids.
+    "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 AssignedLocationService.BulkEditAssignedLocations.
+  "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. Currently, geo region targeting options are the only supported option for assignment.
+      "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. Must be of type TARGETING_TYPE_GEO_REGION.
+    },
+  ],
+}
+
+ +
+ 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. Currently, geo region targeting options are the only supported option for assignment.
+  "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. Must be of type TARGETING_TYPE_GEO_REGION.
+}
+
+  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. Currently, geo region targeting options are the only supported option for assignment.
+  "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. Must be of type TARGETING_TYPE_GEO_REGION.
+}
+
+ +
+ 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 logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedLocationId` The length of this field should be no more than 500 characters.
+  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 `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 `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. Currently, geo region targeting options are the only supported option for assignment.
+      "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. Must be of type TARGETING_TYPE_GEO_REGION.
+    },
+  ],
+  "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_v2.advertisers.locationLists.html b/docs/dyn/displayvideo_v2.advertisers.locationLists.html new file mode 100644 index 00000000000..793a0183740 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"`
+  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 `100`. 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_v2.advertisers.manualTriggers.html b/docs/dyn/displayvideo_v2.advertisers.manualTriggers.html new file mode 100644 index 00000000000..42e1bed671f --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.manualTriggers.html @@ -0,0 +1,323 @@ + + + +

Display & Video 360 API . advertisers . manualTriggers

+

Instance Methods

+

+ activate(advertiserId, triggerId, body=None, x__xgafv=None)

+

Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new manual trigger. Returns the newly created manual trigger if successful.

+

+ deactivate(advertiserId, triggerId, body=None, x__xgafv=None)

+

Deactivates a manual trigger.

+

+ get(advertiserId, triggerId, x__xgafv=None)

+

Gets a manual trigger.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(advertiserId, triggerId, body=None, updateMask=None, x__xgafv=None)

+

Updates a manual trigger. Returns the updated manual trigger if successful.

+

Method Details

+
+ activate(advertiserId, triggerId, body=None, x__xgafv=None) +
Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required)
+  triggerId: string, Required. The ID of the manual trigger to activate. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ManualTriggerService.ActivateManualTrigger.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single manual trigger in Display & Video 360.
+  "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+  "name": "A String", # Output only. The resource name of the manual trigger.
+  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new manual trigger. Returns the newly created manual trigger if successful.
+
+Args:
+  advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single manual trigger in Display & Video 360.
+  "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+  "name": "A String", # Output only. The resource name of the manual trigger.
+  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single manual trigger in Display & Video 360.
+  "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+  "name": "A String", # Output only. The resource name of the manual trigger.
+  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+}
+
+ +
+ deactivate(advertiserId, triggerId, body=None, x__xgafv=None) +
Deactivates a manual trigger.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the manual trigger belongs. (required)
+  triggerId: string, Required. The ID of the manual trigger to deactivate. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ManualTriggerService.DeactivateManualTrigger.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single manual trigger in Display & Video 360.
+  "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+  "name": "A String", # Output only. The resource name of the manual trigger.
+  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+}
+
+ +
+ get(advertiserId, triggerId, x__xgafv=None) +
Gets a manual trigger.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this manual trigger belongs to. (required)
+  triggerId: string, Required. The ID of the manual trigger 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 manual trigger in Display & Video 360.
+  "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+  "name": "A String", # Output only. The resource name of the manual trigger.
+  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the fetched manual triggers belong to. (required)
+  filter: string, Allows filtering by manual trigger properties. 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 operator must be `EQUALS (=)`. * Supported fields: - `displayName` - `state` Examples: * All active manual triggers under an advertiser: `state="ACTIVE"` The length of this field should be no more than 500 characters.
+  orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `state` 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 `100`. 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 `ListManualTriggers` 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:
+
+    {
+  "manualTriggers": [ # The list of manual triggers. This list will be absent if empty.
+    { # A single manual trigger in Display & Video 360.
+      "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+      "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+      "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+      "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+      "name": "A String", # Output only. The resource name of the manual trigger.
+      "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+      "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+    },
+  ],
+  "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 `ListManualTriggers` 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, triggerId, body=None, updateMask=None, x__xgafv=None) +
Updates a manual trigger. Returns the updated manual trigger if successful.
+
+Args:
+  advertiserId: string, Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. (required)
+  triggerId: string, Output only. The unique ID of the manual trigger. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single manual trigger in Display & Video 360.
+  "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+  "name": "A String", # Output only. The resource name of the manual trigger.
+  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+}
+
+  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 manual trigger in Display & Video 360.
+  "activationDurationMinutes": "A String", # Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.
+  "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.
+  "displayName": "A String", # Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.
+  "latestActivationTime": "A String", # Output only. The timestamp of the trigger's latest activation.
+  "name": "A String", # Output only. The resource name of the manual trigger.
+  "state": "A String", # Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.
+  "triggerId": "A String", # Output only. The unique ID of the manual trigger.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v2.advertisers.negativeKeywordLists.html b/docs/dyn/displayvideo_v2.advertisers.negativeKeywordLists.html new file mode 100644 index 00000000000..937333257b6 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 `100`. 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_v2.advertisers.negativeKeywordLists.negativeKeywords.html b/docs/dyn/displayvideo_v2.advertisers.negativeKeywordLists.negativeKeywords.html new file mode 100644 index 00000000000..402fd4edce7 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 keyword currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"`
+  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_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..a93f8028f4b --- /dev/null +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,1540 @@ + + + +

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` (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.
+      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.
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ 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` (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.
+      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.
+  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` (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.
+      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.
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ 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` (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.
+      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.
+  filter: string, Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters.
+  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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "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_v2.advertisers.targetingTypes.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.html new file mode 100644 index 00000000000..cc2215e0d7b --- /dev/null +++ b/docs/dyn/displayvideo_v2.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_v2.combinedAudiences.html b/docs/dyn/displayvideo_v2.combinedAudiences.html new file mode 100644 index 00000000000..98a1f5ca9bb --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.
+  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 `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 `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_v2.customBiddingAlgorithms.html b/docs/dyn/displayvideo_v2.customBiddingAlgorithms.html new file mode 100644 index 00000000000..af2fb6331b4 --- /dev/null +++ b/docs/dyn/displayvideo_v2.customBiddingAlgorithms.html @@ -0,0 +1,342 @@ + + + +

Display & Video 360 API . customBiddingAlgorithms

+

Instance Methods

+

+ 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.

+

+ 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 operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following field: - `displayName` * The operator must be `EQUALS (=)` for the following field: - `customBiddingAlgorithmType` * For `displayName`, the value is a string. We return all custom bidding algorithms whose display_name contains such string. * For `customBiddingAlgorithmType`, the value is a string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type. 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.
+  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 `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 `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.
+
+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",
+  ],
+}
+
+ +
+ 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_v2.customBiddingAlgorithms.scripts.html b/docs/dyn/displayvideo_v2.customBiddingAlgorithms.scripts.html new file mode 100644 index 00000000000..ce17bafa713 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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.

+

+ 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.
+
+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 Script.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 Script.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 Script.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 `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 `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 Script.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_v2.customLists.html b/docs/dyn/displayvideo_v2.customLists.html new file mode 100644 index 00000000000..111771ea460 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.
+  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 `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 `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_v2.firstAndThirdPartyAudiences.html b/docs/dyn/displayvideo_v2.firstAndThirdPartyAudiences.html new file mode 100644 index 00000000000..d69a8bb1f83 --- /dev/null +++ b/docs/dyn/displayvideo_v2.firstAndThirdPartyAudiences.html @@ -0,0 +1,499 @@ + + + +

Display & Video 360 API . firstAndThirdPartyAudiences

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId=None, body=None, x__xgafv=None)

+

Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

+

+ editCustomerMatchMembers(firstAndThirdPartyAudienceId, 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(firstAndThirdPartyAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)

+

Gets a first and third party audience.

+

+ list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

+

Lists first and third party audiences. The order is defined by the order_by parameter.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(firstAndThirdPartyAudienceId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing FirstAndThirdPartyAudience. 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 FirstAndThirdPartyAudience. 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 third party audience list used for targeting. First party audiences are created via usage of client data. Third party 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", # 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", # 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`
+    "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", # 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", # The display name of the first and third party audience.
+  "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`
+  "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`
+    "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 and third party 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 FirstAndThirdPartyAudience 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 third party audience list used for targeting. First party audiences are created via usage of client data. Third party 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", # 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", # 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`
+    "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", # 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", # The display name of the first and third party audience.
+  "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`
+  "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`
+    "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 and third party 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(firstAndThirdPartyAudienceId, 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:
+  firstAndThirdPartyAudienceId: string, Required. The ID of the Customer Match FirstAndThirdPartyAudience 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.
+    "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.
+    "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.
+}
+
+  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.
+  "firstAndThirdPartyAudienceId": "A String", # Required. The ID of the updated Customer Match FirstAndThirdPartyAudience.
+}
+
+ +
+ get(firstAndThirdPartyAudienceId, advertiserId=None, partnerId=None, x__xgafv=None) +
Gets a first and third party audience.
+
+Args:
+  firstAndThirdPartyAudienceId: string, Required. The ID of the first and third party audience to fetch. (required)
+  advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audience.
+  partnerId: string, The ID of the partner that has access to the fetched first and third party 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 third party audience list used for targeting. First party audiences are created via usage of client data. Third party 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", # 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", # 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`
+    "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", # 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", # The display name of the first and third party audience.
+  "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`
+  "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`
+    "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 and third party 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 and third party 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 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 currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.
+  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 `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 `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.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "firstAndThirdPartyAudiences": [ # The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty.
+    { # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party 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", # 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", # 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`
+        "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", # 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", # The display name of the first and third party audience.
+      "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`
+      "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`
+        "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 and third party 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 `ListFirstAndThirdPartyAudiences` 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(firstAndThirdPartyAudienceId, advertiserId=None, body=None, updateMask=None, x__xgafv=None) +
Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
+
+Args:
+  firstAndThirdPartyAudienceId: string, Output only. The unique ID of the first and third party audience. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party 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", # 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", # 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`
+    "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", # 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", # The display name of the first and third party audience.
+  "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`
+  "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`
+    "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 and third party 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 FirstAndThirdPartyAudience.
+  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 third party audience list used for targeting. First party audiences are created via usage of client data. Third party 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", # 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", # 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`
+    "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", # 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", # The display name of the first and third party audience.
+  "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`
+  "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`
+    "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 and third party 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_v2.floodlightGroups.html b/docs/dyn/displayvideo_v2.floodlightGroups.html new file mode 100644 index 00000000000..cf0498e3ab7 --- /dev/null +++ b/docs/dyn/displayvideo_v2.floodlightGroups.html @@ -0,0 +1,191 @@ + + + +

Display & Video 360 API . floodlightGroups

+

Instance Methods

+

+ 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_v2.googleAudiences.html b/docs/dyn/displayvideo_v2.googleAudiences.html new file mode 100644 index 00000000000..3425efb3515 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.
+  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 `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 `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_v2.guaranteedOrders.html b/docs/dyn/displayvideo_v2.guaranteedOrders.html new file mode 100644 index 00000000000..936514a43d8 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 properties. * 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 operator must be `EQUALS (=)`. * 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.
+  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 `100`. If unspecified or greater than `100` 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_v2.html b/docs/dyn/displayvideo_v2.html new file mode 100644 index 00000000000..0a341417a7a --- /dev/null +++ b/docs/dyn/displayvideo_v2.html @@ -0,0 +1,181 @@ + + + +

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.

+ +

+ firstAndThirdPartyAudiences() +

+

Returns the firstAndThirdPartyAudiences 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() +

+

Returns the sdfdownloadtasks Resource.

+ +

+ targetingTypes() +

+

Returns the targetingTypes Resource.

+ +

+ users() +

+

Returns the users Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v2.inventorySourceGroups.assignedInventorySources.html b/docs/dyn/displayvideo_v2.inventorySourceGroups.assignedInventorySources.html new file mode 100644 index 00000000000..5ba648a6612 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedInventorySourceId` The length of this field should be no more than 500 characters.
+  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_v2.inventorySourceGroups.html b/docs/dyn/displayvideo_v2.inventorySourceGroups.html new file mode 100644 index 00000000000..08da73cdc00 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters.
+  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 `100`. 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_v2.inventorySources.html b/docs/dyn/displayvideo_v2.inventorySources.html new file mode 100644 index 00000000000..540003fcc12 --- /dev/null +++ b/docs/dyn/displayvideo_v2.inventorySources.html @@ -0,0 +1,667 @@ + + + +

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, 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`.
+  },
+  "subSitePropertyId": "A String", # Immutable. The unique ID of the sub-site property assigned to this inventory source.
+  "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`.
+  },
+  "subSitePropertyId": "A String", # Immutable. The unique ID of the sub-site property assigned to this inventory source.
+  "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, partnerId=None, x__xgafv=None) +
Gets an inventory source.
+
+Args:
+  inventorySourceId: string, Required. The ID of the inventory source to fetch. (required)
+  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`.
+  },
+  "subSitePropertyId": "A String", # Immutable. The unique ID of the sub-site property assigned to this inventory source.
+  "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 properties. 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 operator must be `EQUALS (=)`. * 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.
+  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 `100`. 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`.
+      },
+      "subSitePropertyId": "A String", # Immutable. The unique ID of the sub-site property assigned to this inventory source.
+      "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`.
+  },
+  "subSitePropertyId": "A String", # Immutable. The unique ID of the sub-site property assigned to this inventory source.
+  "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`.
+  },
+  "subSitePropertyId": "A String", # Immutable. The unique ID of the sub-site property assigned to this inventory source.
+  "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_v2.media.html b/docs/dyn/displayvideo_v2.media.html new file mode 100644 index 00000000000..228e70c7c33 --- /dev/null +++ b/docs/dyn/displayvideo_v2.media.html @@ -0,0 +1,159 @@ + + + +

Display & Video 360 API . media

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ download(resourceName, x__xgafv=None)

+

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.

+

+ download_media(resourceName, x__xgafv=None)

+

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.

+

+ upload(resourceName, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

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.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ download(resourceName, x__xgafv=None) +
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.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See ReadRequest.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:
+
+    { # Media resource.
+  "resourceName": "A String", # Name of the media resource.
+}
+
+ +
+ download_media(resourceName, x__xgafv=None) +
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.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ upload(resourceName, body=None, media_body=None, media_mime_type=None, x__xgafv=None) +
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.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Media resource.
+  "resourceName": "A String", # Name of the media resource.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  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:
+
+    { # Media resource.
+  "resourceName": "A String", # Name of the media resource.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v2.partners.channels.html b/docs/dyn/displayvideo_v2.partners.channels.html new file mode 100644 index 00000000000..2f078ad0b9d --- /dev/null +++ b/docs/dyn/displayvideo_v2.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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.
+  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 `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 `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_v2.partners.channels.sites.html b/docs/dyn/displayvideo_v2.partners.channels.sites.html new file mode 100644 index 00000000000..ca285377278 --- /dev/null +++ b/docs/dyn/displayvideo_v2.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.

+

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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"`
+  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.
+
+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_v2.partners.html b/docs/dyn/displayvideo_v2.partners.html new file mode 100644 index 00000000000..447eb06aa0c --- /dev/null +++ b/docs/dyn/displayvideo_v2.partners.html @@ -0,0 +1,845 @@ + + + +

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", # 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. Output only in v1. Required in v2.
+          },
+          "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.
+          "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. # 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.
+                { # 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.
+                },
+              ],
+            },
+            "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.
+                { # 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.
+                { # 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.
+                { # 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.
+              { # 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.
+                  { # 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.
+                  },
+                ],
+              },
+            ],
+            "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.
+                { # 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", # The audio content type. Output only in v1. Required in v2.
+          },
+          "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+          },
+          "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", # The content outstream position. Output only in v1. Required in v2.
+          },
+          "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", # The display name of the device type. Output only in v1. Required in v2.
+            "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", # The serving environment. Output only in v1. Required in v2.
+          },
+          "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. Output only in v1. Required in v2.
+          },
+          "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", # The gender of the audience. Output only in v1. Required in v2.
+          },
+          "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", # The household income of the audience. Output only in v1. Required in v2.
+          },
+          "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", # The content position. Output only in v1. Required in v2.
+          },
+          "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+          },
+          "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", # The parental status of the audience. Output only in v1. Required in v2.
+          },
+          "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 SearchTargetingOptions. 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".
+          },
+          "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.
+          },
+          "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 settings. # Third party brand verifier -- Adloox.
+              "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+                "A String",
+              ],
+            },
+            "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`, 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**.
+              "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", # The video player size. Output only in v1. Required in v2.
+          },
+          "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+          },
+        },
+      ],
+      "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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+}
+
+ +
+ 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.
+    },
+  },
+  "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 properties. 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 operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters.
+  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 `100`. 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.
+        },
+      },
+      "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_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html new file mode 100644 index 00000000000..647a7680c2e --- /dev/null +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -0,0 +1,1540 @@ + + + +

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.
+      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.
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ 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.
+      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.
+  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.
+      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.
+  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", # 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. Output only in v1. Required in v2.
+  },
+  "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.
+  "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. # 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.
+        { # 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.
+        },
+      ],
+    },
+    "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.
+        { # 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.
+        { # 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.
+        { # 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.
+      { # 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.
+          { # 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.
+          },
+        ],
+      },
+    ],
+    "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.
+        { # 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", # The audio content type. Output only in v1. Required in v2.
+  },
+  "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+  },
+  "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", # The content outstream position. Output only in v1. Required in v2.
+  },
+  "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", # The display name of the device type. Output only in v1. Required in v2.
+    "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", # The serving environment. Output only in v1. Required in v2.
+  },
+  "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. Output only in v1. Required in v2.
+  },
+  "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", # The gender of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The household income of the audience. Output only in v1. Required in v2.
+  },
+  "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", # The content position. Output only in v1. Required in v2.
+  },
+  "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+  },
+  "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", # The parental status of the audience. Output only in v1. Required in v2.
+  },
+  "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 SearchTargetingOptions. 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".
+  },
+  "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.
+  },
+  "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 settings. # Third party brand verifier -- Adloox.
+      "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+        "A String",
+      ],
+    },
+    "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`, 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**.
+      "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", # The video player size. Output only in v1. Required in v2.
+  },
+  "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+  },
+}
+
+ +
+ 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.
+      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.
+  filter: string, Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters.
+  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 `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 `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", # 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. Output only in v1. Required in v2.
+      },
+      "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.
+      "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. # 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.
+            { # 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.
+            },
+          ],
+        },
+        "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.
+            { # 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.
+            { # 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.
+            { # 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.
+          { # 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.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "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.
+            { # 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", # The audio content type. Output only in v1. Required in v2.
+      },
+      "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`. # 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", # The content instream position for video or audio ads. Output only in v1. Required in v2.
+      },
+      "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", # The content outstream position. Output only in v1. Required in v2.
+      },
+      "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", # The display name of the device type. Output only in v1. Required in v2.
+        "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", # The serving environment. Output only in v1. Required in v2.
+      },
+      "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. Output only in v1. Required in v2.
+      },
+      "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", # The gender of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The household income of the audience. Output only in v1. Required in v2.
+      },
+      "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", # The content position. Output only in v1. Required in v2.
+      },
+      "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", # The type of Open Measurement enabled inventory. Output only in v1. Required in v2.
+      },
+      "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", # The parental status of the audience. Output only in v1. Required in v2.
+      },
+      "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 SearchTargetingOptions. 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".
+      },
+      "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.
+      },
+      "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 settings. # Third party brand verifier -- Adloox.
+          "excludedAdlooxCategories": [ # Adloox's brand safety settings.
+            "A String",
+          ],
+        },
+        "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`, 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**.
+          "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", # The video player size. Output only in v1. Required in v2.
+      },
+      "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", # The predicted viewability percentage. Output only in v1. Required in v2.
+      },
+    },
+  ],
+  "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_v2.partners.targetingTypes.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.html new file mode 100644 index 00000000000..4fe4011c3ff --- /dev/null +++ b/docs/dyn/displayvideo_v2.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_v2.sdfdownloadtasks.html b/docs/dyn/displayvideo_v2.sdfdownloadtasks.html new file mode 100644 index 00000000000..6f6b39e3879 --- /dev/null +++ b/docs/dyn/displayvideo_v2.sdfdownloadtasks.html @@ -0,0 +1,171 @@ + + + +

Display & Video 360 API . sdfdownloadtasks

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ 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",
+    ],
+    "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",
+    ],
+    "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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v2.sdfdownloadtasks.operations.html b/docs/dyn/displayvideo_v2.sdfdownloadtasks.operations.html new file mode 100644 index 00000000000..5c85d819f4c --- /dev/null +++ b/docs/dyn/displayvideo_v2.sdfdownloadtasks.operations.html @@ -0,0 +1,124 @@ + + + +

Display & Video 360 API . sdfdownloadtasks . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v2.targetingTypes.html b/docs/dyn/displayvideo_v2.targetingTypes.html new file mode 100644 index 00000000000..83a9510d90b --- /dev/null +++ b/docs/dyn/displayvideo_v2.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_v2.targetingTypes.targetingOptions.html b/docs/dyn/displayvideo_v2.targetingTypes.targetingOptions.html new file mode 100644 index 00000000000..14747fd485e --- /dev/null +++ b/docs/dyn/displayvideo_v2.targetingTypes.targetingOptions.html @@ -0,0 +1,684 @@ + + + +

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.
+      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.
+  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.
+      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.
+  advertiserId: string, Required. The Advertiser this request is being made in the context of.
+  filter: string, Allows filtering by targeting option properties. 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}`. * The operator must be "=" (equal sign). * 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.
+  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 `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 `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.
+      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.
+  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 `100`. 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_v2.users.html b/docs/dyn/displayvideo_v2.users.html new file mode 100644 index 00000000000..ac04aeea914 --- /dev/null +++ b/docs/dyn/displayvideo_v2.users.html @@ -0,0 +1,346 @@ + + + +

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.

+

+ close()

+

Close httplib2 connections.

+

+ create(body=None, x__xgafv=None)

+

Creates a new user. Returns the newly created user if successful.

+

+ delete(userId, x__xgafv=None)

+

Deletes a user.

+

+ get(userId, x__xgafv=None)

+

Gets a user.

+

+ 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.

+

+ 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.

+

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.
+
+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.
+
+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.
+  "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.
+  "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.
+
+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.
+
+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.
+  "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.
+
+Args:
+  filter: string, Allows filtering by user properties. 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 operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following fields: - `displayName` - `email` * The operator must be `EQUALS (=)` for the following fields: - `assignedUserRole.userRole` - `assignedUserRole.partnerId` - `assignedUserRole.advertiserId` - `assignedUserRole.entityType`: A 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`: A synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned." 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"` The length of this field should be no more than 500 characters.
+  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 `100`. 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.
+      "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.
+
+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.
+  "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.
+  "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/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index 5822f88a582..82cc5d8399a 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -1201,6 +1201,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). @@ -2014,6 +2015,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html index 081bdd73ab8..30ef0dab4ae 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html @@ -926,6 +926,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index 1ecac9f4723..96a8b708691 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -1110,6 +1110,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). @@ -1923,6 +1924,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/documentai_v1beta2.projects.documents.html b/docs/dyn/documentai_v1beta2.projects.documents.html index 29d41e75658..467c80f069c 100644 --- a/docs/dyn/documentai_v1beta2.projects.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.documents.html @@ -1068,6 +1068,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/documentai_v1beta2.projects.locations.documents.html b/docs/dyn/documentai_v1beta2.projects.locations.documents.html index 9c7e10c6c60..b7e5a68c9b4 100644 --- a/docs/dyn/documentai_v1beta2.projects.locations.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.locations.documents.html @@ -1068,6 +1068,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 04672f542a5..16fbee17198 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -1209,6 +1209,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). @@ -2007,6 +2008,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). @@ -2820,6 +2822,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html index 354f590ae61..498e0628dd2 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html @@ -873,6 +873,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). @@ -1723,6 +1724,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 586ded38bbf..b8f093cd6b3 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -1118,6 +1118,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). @@ -1916,6 +1917,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). @@ -2729,6 +2731,7 @@

Method Details

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1]. "red": 3.14, # The amount of red in the color as a value in the interval [0, 1]. }, + "fontFamily": "A String", # Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp "fontSize": { # Font size with unit. # Font size. "size": 3.14, # Font size for the text. "unit": "A String", # Unit for the font size. Follows CSS naming (in, px, pt, etc.). diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index dccfbb82bb3..75f45dc9e7a 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -181,7 +181,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -236,31 +240,16 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -280,7 +269,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -300,7 +293,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -321,26 +318,7 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -351,7 +329,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -383,31 +365,16 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -427,7 +394,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -447,7 +418,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -468,26 +443,7 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -521,7 +477,11 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -609,31 +569,16 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -653,7 +598,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -673,7 +622,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -694,26 +647,7 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -724,7 +658,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -756,31 +694,16 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -800,7 +723,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -820,7 +747,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -841,26 +772,7 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -884,7 +796,11 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -924,7 +840,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -962,7 +882,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1028,7 +952,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1081,7 +1009,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1182,7 +1114,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1262,7 +1198,11 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1310,7 +1250,11 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1344,7 +1288,11 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1397,7 +1345,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1484,7 +1436,11 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1532,7 +1488,11 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1566,7 +1526,11 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1611,7 +1575,11 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1663,7 +1631,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1703,7 +1675,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1777,7 +1753,11 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1825,7 +1805,11 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1859,7 +1843,11 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1903,7 +1891,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1961,31 +1953,16 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2005,7 +1982,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2025,7 +2006,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2046,26 +2031,7 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -2076,7 +2042,11 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2108,31 +2078,16 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2152,7 +2107,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2172,7 +2131,11 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2193,26 +2156,7 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "booleanValue": True or False, # A boolean value. - "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. - "doubleValue": 3.14, # A double value. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "mapValue": { # A map value. # A map value. - "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. - "a_key": # Object with schema name: Value - }, - }, - "nullValue": "A String", # A null value. - "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. - "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. - "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. - }, + # Object with schema name: Value ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -2238,7 +2182,11 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "values": [ # Values in the array. + # Object with schema name: Value + ], + }, "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index a2ffdbb174c..0608c846bf7 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -140,6 +140,7 @@

Method Details

}, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -213,6 +214,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, }, }, @@ -300,6 +302,7 @@

Method Details

}, "membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -406,6 +409,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. @@ -544,6 +556,7 @@

Method Details

}, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -617,6 +630,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, }, }, @@ -704,6 +718,7 @@

Method Details

}, "membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -810,6 +825,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. @@ -936,6 +960,7 @@

Method Details

}, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1009,6 +1034,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, }, }, @@ -1096,6 +1122,7 @@

Method Details

}, "membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1202,6 +1229,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. @@ -1284,6 +1320,7 @@

Method Details

}, "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1357,6 +1394,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, }, }, @@ -1444,6 +1482,7 @@

Method Details

}, "membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1550,6 +1589,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index c32c7209884..76574292cb7 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -152,6 +152,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -226,6 +227,7 @@

Method Details

"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -346,6 +348,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -685,6 +688,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -759,6 +763,7 @@

Method Details

"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -879,6 +884,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1206,6 +1212,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1280,6 +1287,7 @@

Method Details

"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1400,6 +1408,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1683,6 +1692,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1757,6 +1767,7 @@

Method Details

"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1877,6 +1888,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html index b462967eb46..c1df044eae6 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html @@ -113,6 +113,9 @@

Instance Methods

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

+ validateCreate(parent, body=None, x__xgafv=None)

+

ValidateCreateMembership is a preflight check for CreateMembership. It checks the following: 1. Caller has the required `gkehub.memberships.create` permission. 2. The membership_id is still available.

Method Details

close() @@ -893,4 +896,108 @@

Method Details

}
+
+ validateCreate(parent, body=None, x__xgafv=None) +
ValidateCreateMembership is a preflight check for CreateMembership. It checks the following: 1. Caller has the required `gkehub.memberships.create` permission. 2. The membership_id is still available.
+
+Args:
+  parent: string, Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the `GkeHub.ValidateCreateMembership` method.
+  "membership": { # Membership contains information about a member cluster. # Required. Membership resource to be created.
+    "authority": { # Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity # Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
+      "identityProvider": "A String", # Output only. An identity provider that reflects the `issuer` in the workload identity pool.
+      "issuer": "A String", # Optional. A JSON Web Token (JWT) issuer URI. `issuer` must start with `https://` and be a valid URL with length <2000 characters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearing `issuer` disables Workload Identity. `issuer` cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity).
+      "oidcJwks": "A String", # Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field.
+      "workloadIdentityPool": "A String", # Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API.
+    },
+    "createTime": "A String", # Output only. When the Membership was created.
+    "deleteTime": "A String", # Output only. When the Membership was deleted.
+    "description": "A String", # Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes.
+    "endpoint": { # MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. # Optional. Endpoint information to reach this member.
+      "applianceCluster": { # ApplianceCluster contains information specific to GDC Edge Appliance Clusters. # Optional. Specific information for a GDC Edge Appliance cluster.
+        "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
+      },
+      "edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster.
+        "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
+      },
+      "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster.
+        "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
+        "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
+      },
+      "kubernetesMetadata": { # KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. # Output only. Useful Kubernetes-specific metadata.
+        "kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`.
+        "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
+        "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources.
+        "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
+        "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
+        "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources.
+      },
+      "kubernetesResource": { # KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After CreateMembership or UpdateMembership, these resources should be re-applied in the cluster. # Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
+        "connectResources": [ # Output only. The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
+          { # ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
+            "clusterScoped": True or False, # Whether the resource provided in the manifest is `cluster_scoped`. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster.
+            "manifest": "A String", # YAML manifest of the resource.
+          },
+        ],
+        "membershipCrManifest": "A String", # Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
+        "membershipResources": [ # Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
+          { # ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
+            "clusterScoped": True or False, # Whether the resource provided in the manifest is `cluster_scoped`. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster.
+            "manifest": "A String", # YAML manifest of the resource.
+          },
+        ],
+        "resourceOptions": { # ResourceOptions represent options for Kubernetes resource generation. # Optional. Options for Kubernetes resource generation.
+          "connectVersion": "A String", # Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
+          "k8sVersion": "A String", # Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.
+          "v1beta1Crd": True or False, # Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
+        },
+      },
+      "multiCloudCluster": { # MultiCloudCluster contains information specific to GKE Multi-Cloud clusters. # Optional. Specific information for a GKE Multi-Cloud cluster.
+        "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
+        "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
+      },
+      "onPremCluster": { # OnPremCluster contains information specific to GKE On-Prem clusters. # Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
+        "adminCluster": True or False, # Immutable. Whether the cluster is an admin cluster.
+        "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
+        "clusterType": "A String", # Immutable. The on prem cluster's type.
+        "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
+      },
+    },
+    "externalId": "A String", # Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object.
+    "labels": { # Optional. GCP labels for this membership.
+      "a_key": "A String",
+    },
+    "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.
+    "name": "A String", # Output only. The full, unique name of this Membership resource in the format `projects/*/locations/*/memberships/{membership_id}`, set during creation. `membership_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
+    "state": { # MembershipState describes the state of a Membership resource. # Output only. State of the Membership resource.
+      "code": "A String", # Output only. The current state of the Membership resource.
+    },
+    "uniqueId": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different unique_id.
+    "updateTime": "A String", # Output only. When the Membership was last updated.
+  },
+  "membershipId": "A String", # Required. Client chosen membership id.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the `GkeHub.ValidateCreateMembership` method.
+  "validationResults": [ # Wraps all the validator results.
+    { # ValidationResults are results set by each validator running during ValidateCreateMembership.
+      "result": "A String", # Additional information for the validation.
+      "success": True or False, # Whether the validation is passed or not.
+      "validator": "A String", # Validator type to validate membership with.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index 098568366d0..20d6f36e401 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -152,6 +152,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -225,6 +226,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -342,6 +344,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -462,6 +465,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. @@ -620,6 +632,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -693,6 +706,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -810,6 +824,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -930,6 +945,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. @@ -1076,6 +1100,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1149,6 +1174,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1266,6 +1292,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1386,6 +1413,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. @@ -1488,6 +1524,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1561,6 +1598,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Enables automatic control plane management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1678,6 +1716,7 @@

Method Details

"enabled": True or False, # Whether binauthz is enabled in this cluster. }, "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. + "allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. @@ -1798,6 +1837,15 @@

Method Details

], "state": "A String", # LifecycleState of control plane management. }, + "dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management. + "details": [ # Explanation of the status. + { # Structured and human-readable details for a status. + "code": "A String", # A machine-readable code that further describes a broad status. + "details": "A String", # Human-readable explanation of code. + }, + ], + "state": "A String", # Lifecycle status of data plane management. + }, }, "state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership. "code": "A String", # The high-level, machine-readable status of this Feature. diff --git a/docs/dyn/identitytoolkit_v2.projects.tenants.html b/docs/dyn/identitytoolkit_v2.projects.tenants.html index b4362c26e77..8c083aa805f 100644 --- a/docs/dyn/identitytoolkit_v2.projects.tenants.html +++ b/docs/dyn/identitytoolkit_v2.projects.tenants.html @@ -163,6 +163,11 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. + "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging + "enabled": True or False, # Whether logging is enabled for this project or not. + }, + }, "name": "A String", # Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}" "testPhoneNumbers": { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded). "a_key": "A String", @@ -206,6 +211,11 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. + "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging + "enabled": True or False, # Whether logging is enabled for this project or not. + }, + }, "name": "A String", # Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}" "testPhoneNumbers": { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded). "a_key": "A String", @@ -274,6 +284,11 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. + "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging + "enabled": True or False, # Whether logging is enabled for this project or not. + }, + }, "name": "A String", # Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}" "testPhoneNumbers": { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded). "a_key": "A String", @@ -385,6 +400,11 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. + "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging + "enabled": True or False, # Whether logging is enabled for this project or not. + }, + }, "name": "A String", # Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}" "testPhoneNumbers": { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded). "a_key": "A String", @@ -446,6 +466,11 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. + "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging + "enabled": True or False, # Whether logging is enabled for this project or not. + }, + }, "name": "A String", # Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}" "testPhoneNumbers": { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded). "a_key": "A String", @@ -490,6 +515,11 @@

Method Details

], "state": "A String", # Whether MultiFactor Authentication has been enabled for this project. }, + "monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity. + "requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging + "enabled": True or False, # Whether logging is enabled for this project or not. + }, + }, "name": "A String", # Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}" "testPhoneNumbers": { # A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded). "a_key": "A String", diff --git a/docs/dyn/index.md b/docs/dyn/index.md index d0de9047c6b..7137a7852ec 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -59,6 +59,7 @@ ## analyticshub +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/analyticshub_v1.html) * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/analyticshub_v1beta1.html) @@ -117,6 +118,7 @@ ## assuredworkloads * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/assuredworkloads_v1.html) +* [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/assuredworkloads_v1beta1.html) ## authorizedbuyersmarketplace @@ -220,6 +222,7 @@ ## cloudbilling * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudbilling_v1.html) +* [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudbilling_v1beta.html) ## cloudbuild @@ -419,6 +422,7 @@ ## displayvideo * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/displayvideo_v1.html) +* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/displayvideo_v2.html) ## dlp @@ -641,6 +645,10 @@ * [v3](http://googleapis.github.io/google-api-python-client/docs/dyn/indexing_v3.html) +## integrations +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/integrations_v1alpha.html) + + ## jobs * [v3](http://googleapis.github.io/google-api-python-client/docs/dyn/jobs_v3.html) * [v3p1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/jobs_v3p1beta1.html) diff --git a/docs/dyn/integrations_v1alpha.callback.html b/docs/dyn/integrations_v1alpha.callback.html new file mode 100644 index 00000000000..d14dd0b1342 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.callback.html @@ -0,0 +1,117 @@ + + + +

Application Integration API . callback

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ generateToken(code=None, gcpProjectId=None, product=None, redirectUri=None, state=None, x__xgafv=None)

+

Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generateToken(code=None, gcpProjectId=None, product=None, redirectUri=None, state=None, x__xgafv=None) +
Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.
+
+Args:
+  code: string, The auth code for the given request
+  gcpProjectId: string, The gcp project id of the request
+  product: string, Which product sends the request
+    Allowed values
+      UNSPECIFIED_PRODUCT - 
+      IP - 
+      APIGEE - 
+      SECURITY - 
+  redirectUri: string, Redirect uri of the auth code request
+  state: string, The auth config id for the given request
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Returns success or error message
+  "message": "A String", # The message that notifies the user if the request succeeded or not.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.connectorPlatformRegions.html b/docs/dyn/integrations_v1alpha.connectorPlatformRegions.html new file mode 100644 index 00000000000..ed44de9a2b2 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.connectorPlatformRegions.html @@ -0,0 +1,109 @@ + + + +

Application Integration API . connectorPlatformRegions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ enumerate(x__xgafv=None)

+

Enumerates the regions for which Connector Platform is provisioned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ enumerate(x__xgafv=None) +
Enumerates the regions for which Connector Platform is provisioned.
+
+Args:
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing all provisioned regions for Connector Platform.
+  "regions": [ # All regions where Connector Platform is provisioned.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.html b/docs/dyn/integrations_v1alpha.html new file mode 100644 index 00000000000..6abbb90bd60 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.html @@ -0,0 +1,121 @@ + + + +

Application Integration API

+

Instance Methods

+

+ callback() +

+

Returns the callback Resource.

+ +

+ connectorPlatformRegions() +

+

Returns the connectorPlatformRegions Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

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

Application Integration API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.appsScriptProjects.html b/docs/dyn/integrations_v1alpha.projects.locations.appsScriptProjects.html new file mode 100644 index 00000000000..c8efd603eed --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.appsScriptProjects.html @@ -0,0 +1,145 @@ + + + +

Application Integration API . projects . locations . appsScriptProjects

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an Apps Script project.

+

+ link(parent, body=None, x__xgafv=None)

+

Links a existing Apps Script project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an Apps Script project.
+
+Args:
+  parent: string, Required. The project that the executed integration belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for CreateAppsScriptProject rpc call.
+  "appsScriptProject": "A String", # The name of the Apps Script project to be created.
+  "authConfigId": "A String", # The auth config id necessary to fetch the necessary credentials to create the project for external clients
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for CreateAppsScriptProject rpc call.
+  "projectId": "A String", # The created AppsScriptProject ID.
+}
+
+ +
+ link(parent, body=None, x__xgafv=None) +
Links a existing Apps Script project.
+
+Args:
+  parent: string, Required. The project that the executed integration belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for LinkAppsScriptProject rpc call.
+  "scriptId": "A String", # The id of the Apps Script project to be linked.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for LinkAppsScriptProject rpc call.
+  "scriptId": "A String", # The id of the linked Apps Script project.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html b/docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html new file mode 100644 index 00000000000..c9ac360a904 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.authConfigs.html @@ -0,0 +1,2420 @@ + + + +

Application Integration API . projects . locations . authConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, x__xgafv=None)

+

Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.

+

+ delete(name, x__xgafv=None)

+

Deletes an auth config.

+

+ get(name, x__xgafv=None)

+

Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None)

+

Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, x__xgafv=None) +
Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
+
+Args:
+  parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+  clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+  clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an auth config.
+
+Args:
+  name: string, Required. The name that is associated with the AuthConfig. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
+
+Args:
+  name: string, Required. The name that is associated with the AuthConfig. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
+
+Args:
+  parent: string, Required. The client, which owns this collection of AuthConfigs. (required)
+  filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+  pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+  pageToken: string, The token returned in the previous response.
+  readMask: string, The mask which specifies fields that need to be returned in the AuthConfig's response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list AuthConfigs.
+  "authConfigs": [ # The list of AuthConfigs retrieved.
+    { # The AuthConfig resource use to hold channels and connection config data.
+      "certificateId": "A String", # Certificate id for client certificate
+      "createTime": "A String", # Output only. The timestamp when the auth config is created.
+      "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "credentialType": "A String", # Credential type of the encrypted credential.
+      "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+        "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+          "token": "A String", # The token for the auth type.
+          "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+        },
+        "credentialType": "A String", # Credential type associated with auth config.
+        "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+          "jwt": "A String", # The token calculated by the header, payload and signature.
+          "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+          "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+          "secret": "A String", # User's pre-shared secret to sign the token.
+        },
+        "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+          "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+            "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+            "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+            "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+            "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+            "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+          },
+          "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+          "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+          "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+          "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+          "clientId": "A String", # The client's id.
+          "clientSecret": "A String", # The client's secret.
+          "requestType": "A String", # Represent how to pass parameters to fetch access token
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+          "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+        },
+        "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+          "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+            "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+            "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+            "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+            "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+            "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+          },
+          "clientId": "A String", # The client's ID.
+          "clientSecret": "A String", # The client's secret.
+          "requestType": "A String", # Represent how to pass parameters to fetch access token
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+          "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+        },
+        "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+          "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+            "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+            "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+            "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+            "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+            "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+          },
+          "clientId": "A String", # The client's ID.
+          "clientSecret": "A String", # The client's secret.
+          "password": "A String", # The user's password.
+          "requestType": "A String", # Represent how to pass parameters to fetch access token
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+          "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+          "username": "A String", # The user's username.
+        },
+        "oidcToken": { # OIDC Token # Google OIDC ID Token
+          "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+          "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+          "token": "A String", # ID token obtained for the service account
+          "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+        },
+        "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+        },
+        "usernameAndPassword": { # Username and password pair. # Username and password credential
+          "password": "A String", # Password to be used
+          "username": "A String", # Username to be used
+        },
+      },
+      "description": "A String", # A description of the auth config.
+      "displayName": "A String", # The name of the auth config.
+      "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+      "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+        "A String",
+      ],
+      "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+      "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+      "reason": "A String", # The reason / details of the current status.
+      "state": "A String", # The status of the auth config.
+      "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+      "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+      "visibility": "A String", # The visibility of the auth config.
+    },
+  ],
+  "nextPageToken": "A String", # The token used 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(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None) +
Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
+
+Args:
+  name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+  clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+  clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  updateMask: string, Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.certificates.html b/docs/dyn/integrations_v1alpha.projects.locations.certificates.html new file mode 100644 index 00000000000..cd58559a45b --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.certificates.html @@ -0,0 +1,120 @@ + + + +

Application Integration API . projects . locations . certificates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a certificates in the specified project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a certificates in the specified project.
+
+Args:
+  name: string, Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The certificate definition
+  "certificateStatus": "A String", # Status of the certificate
+  "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+  "description": "A String", # Description of the certificate
+  "displayName": "A String", # Name of the certificate
+  "name": "A String", # Output only. Auto generated primary key
+  "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+    "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+    "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+    "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  },
+  "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+  "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+  "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.connections.html b/docs/dyn/integrations_v1alpha.projects.locations.connections.html new file mode 100644 index 00000000000..a675f5ae8de --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.connections.html @@ -0,0 +1,268 @@ + + + +

Application Integration API . projects . locations . connections

+

Instance Methods

+

+ runtimeActionSchemas() +

+

Returns the runtimeActionSchemas Resource.

+ +

+ runtimeEntitySchemas() +

+

Returns the runtimeEntitySchemas Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ getConnectionSchemaMetadata(name, x__xgafv=None)

+

Lists the available entities and actions associated with a Connection.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Connections in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getConnectionSchemaMetadata(name, x__xgafv=None) +
Lists the available entities and actions associated with a Connection.
+
+Args:
+  name: string, Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Metadata of runtime connection schema.
+  "actions": [ # List of actions.
+    "A String",
+  ],
+  "entities": [ # List of entity names.
+    "A String",
+  ],
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Connections in a given project and location.
+
+Args:
+  parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required)
+  filter: string, Filter.
+  orderBy: string, Order by parameters.
+  pageSize: integer, Page size.
+  pageToken: string, 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 containing Connections listed by region.
+  "connections": [ # Connections.
+    { # Connection represents an instance of connector.
+      "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
+        "additionalVariables": [ # List containing additional auth configs.
+          { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
+            "boolValue": True or False, # Value is a bool.
+            "intValue": "A String", # Value is an integer
+            "key": "A String", # Key of the config variable.
+            "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+              "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+            },
+            "stringValue": "A String", # Value is a string.
+          },
+        ],
+        "authType": "A String", # The type of authentication configured.
+        "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials.
+          "clientId": "A String", # The client identifier.
+          "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+        },
+        "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer.
+          "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+          "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token.
+            "audience": "A String", # Value for the "aud" claim.
+            "issuer": "A String", # Value for the "iss" claim.
+            "subject": "A String", # Value for the "sub" claim.
+          },
+        },
+        "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
+          "certType": "A String", # Format of SSH Client cert.
+          "password": { # Secret provides a reference to entries in Secret Manager. # This is an optional field used in case client has enabled multi-factor authentication
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+          "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+          "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one.
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+          "username": "A String", # The user account used to authenticate.
+        },
+        "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword.
+          "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password.
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+          "username": "A String", # Username.
+        },
+      },
+      "configVariables": [ # Optional. Configuration for configuring the connection with an external system.
+        { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
+          "boolValue": True or False, # Value is a bool.
+          "intValue": "A String", # Value is an integer
+          "key": "A String", # Key of the config variable.
+          "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+            "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+          },
+          "stringValue": "A String", # Value is a string.
+        },
+      ],
+      "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
+      "createTime": "A String", # Output only. Created time.
+      "description": "A String", # Optional. Description of the resource.
+      "destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
+        { # Define the Connectors target endpoint.
+          "destinations": [ # The destinations for the key.
+            {
+              "host": "A String", # For publicly routable host.
+              "port": 42, # The port is the target port number that is accepted by the destination.
+              "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+            },
+          ],
+          "key": "A String", # The key is the destination identifier that is supported by the Connector.
+        },
+      ],
+      "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
+      "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
+      "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+        "a_key": "A String",
+      },
+      "lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
+        "locked": True or False, # Indicates whether or not the connection is locked.
+        "reason": "A String", # Describes why a connection is locked.
+      },
+      "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
+      "nodeConfig": { # Configuration for the connection. # Optional. Configuration for the connection.
+        "maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
+        "minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
+      },
+      "serviceAccount": "A String", # Optional. Service account needed for runtime plane to access GCP resources.
+      "serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"
+      "status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
+        "description": "A String", # Description.
+        "state": "A String", # State.
+        "status": "A String", # Status provides detailed information for the state.
+      },
+      "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
+      "updateTime": "A String", # Output only. Updated time.
+    },
+  ],
+  "nextPageToken": "A String", # Next page token.
+}
+
+ +
+ 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/integrations_v1alpha.projects.locations.connections.runtimeActionSchemas.html b/docs/dyn/integrations_v1alpha.projects.locations.connections.runtimeActionSchemas.html new file mode 100644 index 00000000000..2051e92bd13 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.connections.runtimeActionSchemas.html @@ -0,0 +1,135 @@ + + + +

Application Integration API . projects . locations . connections . runtimeActionSchemas

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
+
+Args:
+  parent: string, Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection} (required)
+  filter: string, Filter. Only the action field with literal equality operator is supported.
+  pageSize: integer, Page size.
+  pageToken: string, 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 for listing RuntimeActionSchemas for a specific Connection.
+  "nextPageToken": "A String", # Next page token.
+  "runtimeActionSchemas": [ # Runtime action schemas.
+    { # Metadata of an action, including schemas for its inputs and outputs.
+      "action": "A String", # Name of the action.
+      "inputSchema": "A String", # Input parameter schema for the action.
+      "outputSchema": "A String", # Output parameter schema for the action.
+    },
+  ],
+}
+
+ +
+ 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/integrations_v1alpha.projects.locations.connections.runtimeEntitySchemas.html b/docs/dyn/integrations_v1alpha.projects.locations.connections.runtimeEntitySchemas.html new file mode 100644 index 00000000000..ad2d3409086 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.connections.runtimeEntitySchemas.html @@ -0,0 +1,135 @@ + + + +

Application Integration API . projects . locations . connections . runtimeEntitySchemas

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the JSON schemas for the properties of runtime entities, filtered by entity name.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
+
+Args:
+  parent: string, Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection} (required)
+  filter: string, Filter. Only the entity field with literal equality operator is supported.
+  pageSize: integer, Page size.
+  pageToken: string, 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 for listing RuntimeEntitySchemas for a specific Connection.
+  "nextPageToken": "A String", # Next page token.
+  "runtimeEntitySchemas": [ # Runtime entity schemas.
+    { # Metadata of an entity, including a schema for its properties.
+      "arrayFieldSchema": "A String", # The above schema, but for an array of the associated entity.
+      "entity": "A String", # Name of the entity.
+      "fieldSchema": "A String", # List of fields in the entity.
+    },
+  ],
+}
+
+ +
+ 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/integrations_v1alpha.projects.locations.html b/docs/dyn/integrations_v1alpha.projects.locations.html new file mode 100644 index 00000000000..49a90bff4a2 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.html @@ -0,0 +1,287 @@ + + + +

Application Integration API . projects . locations

+

Instance Methods

+

+ appsScriptProjects() +

+

Returns the appsScriptProjects Resource.

+ +

+ authConfigs() +

+

Returns the authConfigs Resource.

+ +

+ certificates() +

+

Returns the certificates Resource.

+ +

+ connections() +

+

Returns the connections Resource.

+ +

+ integrations() +

+

Returns the integrations Resource.

+ +

+ products() +

+

Returns the products Resource.

+ +

+ sfdcInstances() +

+

Returns the sfdcInstances Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ listTaskEntities(parent, x__xgafv=None)

+

This is a UI only method and will be moved away. Returns a list of common tasks.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ listTaskEntities(parent, x__xgafv=None) +
This is a UI only method and will be moved away. Returns a list of common tasks.
+
+Args:
+  parent: string, Required. The location resource of the request. This is not going to be used but preserve the field for future. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This is a UI only method and will be moved away. Response for ListTaskEntities.
+  "taskEntities": [ # The list of the tasks.
+    { # Contains a task's metadata and associated information. Next available id: 7
+      "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+      "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+        "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+        "admins": [
+          { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+            "googleGroupEmail": "A String",
+            "userEmail": "A String",
+          },
+        ],
+        "category": "A String",
+        "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+        "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+        "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+        "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+        "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+        "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+        "externalCategory": "A String",
+        "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+        "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+        "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+        "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+        "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+        "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+        "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+        "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+        "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+        "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+        "system": "A String",
+        "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+          "A String",
+        ],
+      },
+      "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+        "parameters": [
+          { # Key-value pair of EventBus task parameters. Next id: 13
+            "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+            "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+            "config": { # Optional fields, such as help text and other useful info.
+              "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+              "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+              "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+              "inputDisplayOption": "A String",
+              "isHidden": True or False, # Whether this field is hidden in the UI.
+              "label": "A String", # A user-friendly label for the parameter.
+              "parameterNameOption": "A String",
+              "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+              "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+            },
+            "dataType": "A String", # The data type of the parameter.
+            "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+            "isOutput": True or False,
+            "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+            "protoDef": { # Populated if this represents a proto or proto array.
+              "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+              "path": "A String", # Path to the proto file that contains the message type's definition.
+            },
+            "required": True or False, # If set, the user must provide an input value for this parameter.
+            "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+              "doubleRange": { # Range used to validate doubles and floats.
+                "max": 3.14, # The inclusive maximum of the acceptable range.
+                "min": 3.14, # The inclusive minimum of the acceptable range.
+              },
+              "intRange": { # Range used to validate longs and ints.
+                "max": "A String", # The inclusive maximum of the acceptable range.
+                "min": "A String", # The inclusive minimum of the acceptable range.
+              },
+              "stringRegex": { # Rule used to validate strings.
+                "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                "regex": "A String", # The regex applied to the input value(s).
+              },
+            },
+          },
+        ],
+      },
+      "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+        "dimensions": { # Dimensions that these stats have been aggregated on.
+          "clientId": "A String",
+          "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+          "errorEnumString": "A String",
+          "retryAttempt": "A String",
+          "taskName": "A String",
+          "taskNumber": "A String",
+          "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+          "warningEnumString": "A String",
+          "workflowId": "A String",
+          "workflowName": "A String",
+        },
+        "durationInSeconds": 3.14, # Average duration in seconds.
+        "errorRate": 3.14, # Average error rate.
+        "qps": 3.14, # Queries per second.
+        "warningRate": 3.14, # Average warning rate.
+      },
+      "taskType": "A String", # Defines the type of the task
+      "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+        "taskUiModuleConfigs": [ # Configurations of included config modules.
+          { # Task author would use this type to configure a config module.
+            "moduleId": "A String", # ID of the config module.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html new file mode 100644 index 00000000000..826e800adc0 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.executions.html @@ -0,0 +1,783 @@ + + + +

Application Integration API . projects . locations . integrations . executions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_triggerId=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, truncateParams=None, x__xgafv=None)

+

Lists the status of the integration executions.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_triggerId=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, truncateParams=None, x__xgafv=None) +
Lists the status of the integration executions.
+
+Args:
+  parent: string, Required. The parent resource name of the integration execution. (required)
+  filter: string, Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
+  filterParams_customFilter: string, Optional user-provided custom filter.
+  filterParams_endTime: string, End timestamp.
+  filterParams_eventStatuses: string, List of possible event statuses. (repeated)
+  filterParams_executionId: string, Execution id.
+  filterParams_parameterKey: string, Param key. DEPRECATED. User parameter_pair_key instead.
+  filterParams_parameterPairKey: string, Param key in the key value pair filter.
+  filterParams_parameterPairValue: string, Param value in the key value pair filter.
+  filterParams_parameterType: string, Param type.
+  filterParams_parameterValue: string, Param value. DEPRECATED. User parameter_pair_value instead.
+  filterParams_startTime: string, Start timestamp.
+  filterParams_taskStatuses: string, List of possible task statuses. (repeated)
+  filterParams_triggerId: string, Trigger id.
+  filterParams_workflowName: string, Workflow name.
+  orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
+  pageSize: integer, Optional. The size of entries in the response.
+  pageToken: string, Optional. The token returned in the previous response.
+  readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.
+  refreshAcl: boolean, Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
+  truncateParams: boolean, Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for listing the integration execution data.
+  "executionInfos": [ # Required. The detailed information of requested executions.
+    { # Contains all the execution details for a workflow instance. Next available id: 24
+      "clientId": "A String", # The event data user sends as request.
+      "createTime": "A String", # Auto-generated.
+      "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # Final error-code if event failed.
+        "commonErrorCode": "A String",
+      },
+      "errors": [ # Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.
+        { # An error, warning, or information message associated with a workflow.
+          "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # The associated error-code, which can be a common or internal code.
+            "commonErrorCode": "A String",
+          },
+          "errorMessage": "A String", # The full text of the error message, including any parameters that were thrown along with the exception.
+          "severity": "A String", # The severity of the error: ERROR|WARN|INFO.
+          "taskNumber": 42, # The task try-number, in which, the error occurred. If zero, the error happened at the event level.
+        },
+      ],
+      "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+        "eventAttemptStats": [
+          {
+            "endTime": "A String", # The end time of the event execution for current attempt.
+            "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+          },
+        ],
+        "eventExecutionSnapshot": [ # After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible.
+          {
+            "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+            "conditionResults": [ # All of the computed conditions that been calculated.
+              { # Contains the combined condition calculation results.
+                "currentTaskNumber": "A String", # the current task number.
+                "nextTaskNumber": "A String", # the next task number.
+                "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+              },
+            ],
+            "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+                { # Key-value pair of EventBus parameters.
+                  "dataType": "A String", # Explicitly getting the type of the parameter.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                  "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+            "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+            "eventExecutionSnapshotMetadata": {
+              "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+              "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+              "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+              "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+            },
+            "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+                { # Key-value pair of EventBus parameters.
+                  "dataType": "A String", # Explicitly getting the type of the parameter.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                  "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "snapshotTime": "A String", # Indicates when this snapshot is taken.
+            "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+              { # Contains the details of the execution of this task. Next available id: 11
+                "taskAttemptStats": [
+                  {
+                    "endTime": "A String", # The end time of the task execution for current attempt.
+                    "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+                  },
+                ],
+                "taskExecutionState": "A String",
+                "taskNumber": "A String", # Pointer to the task config it used for execution.
+              },
+            ],
+            "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+          },
+        ],
+        "eventExecutionState": "A String", # The execution state of this event.
+        "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+        "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+        "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+        "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+        "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+      },
+      "eventExecutionInfoId": "A String", # Auto-generated primary key.
+      "executionTraceInfo": { # Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships. # Execution trace info to aggregate parent-child executions.
+        "parentEventExecutionInfoId": "A String", # Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.
+        "traceId": "A String", # Used to aggregate ExecutionTraceInfo.
+      },
+      "lastModifiedTime": "A String", # Auto-generated.
+      "postMethod": "A String", # The ways user posts this event.
+      "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default.
+      "requestId": "A String", # Optional. This is used to de-dup incoming request.
+      "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come in as part of the request.
+        "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+          { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        ],
+      },
+      "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come out as part of the response.
+        "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+          { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        ],
+      },
+      "snapshotNumber": "A String", # Workflow snapshot number.
+      "tenant": "A String", # Tenant this event is created. Used to reschedule the event to correct tenant.
+      "triggerId": "A String", # The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+      "workflowId": "A String", # Required. Pointer to the workflow it is executing.
+      "workflowName": "A String", # Name of the workflow.
+      "workflowRetryBackoffIntervalSeconds": "A String", # Time interval in seconds to schedule retry of workflow in manifold when workflow is already running
+    },
+  ],
+  "executions": [ # The detailed information of requested executions
+    { # The Execution resource contains detailed information of an individual integration execution.
+      "createTime": "A String", # Output only. Created time of the execution.
+      "directSubExecutions": [ # Direct sub executions of the following Execution.
+        # Object with schema name: GoogleCloudIntegrationsV1alphaExecution
+      ],
+      "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+        "eventAttemptStats": [
+          {
+            "endTime": "A String", # The end time of the event execution for current attempt.
+            "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+          },
+        ],
+        "eventExecutionSnapshot": [
+          { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+            "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+            "conditionResults": [ # All of the computed conditions that been calculated.
+              { # Contains the combined condition calculation results.
+                "currentTaskNumber": "A String", # the current task number.
+                "nextTaskNumber": "A String", # the next task number.
+                "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+              },
+            ],
+            "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+            "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+            "eventExecutionSnapshotMetadata": {
+              "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+              "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+              "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+              "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+            },
+            "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+            "snapshotTime": "A String", # Indicates when this snapshot is taken.
+            "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+              { # Contains the details of the execution of this task. Next available id: 11
+                "taskAttemptStats": [
+                  {
+                    "endTime": "A String", # The end time of the task execution for current attempt.
+                    "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+                  },
+                ],
+                "taskExecutionState": "A String",
+                "taskNumber": "A String", # Pointer to the task config it used for execution.
+              },
+            ],
+            "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+          },
+        ],
+        "eventExecutionState": "A String",
+        "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+        "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+        "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+        "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+        "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+      },
+      "executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
+        "attemptStats": [ # List of Start and end time of the execution attempts.
+          { # Status for the execution attempt.
+            "endTime": "A String", # The end time of the event execution for current attempt.
+            "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+          },
+        ],
+        "executionSnapshots": [ # List of snapshots taken during the execution.
+          { # Contains the snapshot of the execution for a given checkpoint.
+            "checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
+            "executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
+              "executionAttempt": 42, # the execution attempt number this snapshot belongs to.
+              "task": "A String", # the task name associated with this snapshot.
+              "taskAttempt": 42, # the task attempt number this snapshot belongs to.
+              "taskNumber": "A String", # The task number associated with this snapshot.
+            },
+            "params": { # Parameters used during the execution.
+              "a_key": { # The type of the parameter.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+            },
+            "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+              { # Contains the details of the execution of this task.
+                "taskAttemptStats": [ # Status for the current task execution attempt.
+                  { # Status for the execution attempt.
+                    "endTime": "A String", # The end time of the event execution for current attempt.
+                    "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+                  },
+                ],
+                "taskExecutionState": "A String", # The execution state of this task.
+                "taskNumber": "A String", # Pointer to the task config it used for execution.
+              },
+            ],
+          },
+        ],
+        "state": "A String", # Status of the execution.
+      },
+      "executionMethod": "A String", # The ways user posts this event.
+      "name": "A String", # Auto-generated primary key.
+      "requestParameters": { # Event parameters come in as part of the request.
+        "a_key": { # The type of the parameter.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+      },
+      "requestParams": [ # Event parameters come in as part of the request.
+        { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      ],
+      "responseParameters": { # Event parameters returned as part of the response.
+        "a_key": { # The type of the parameter.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+      },
+      "responseParams": [ # Event parameters come out as part of the response.
+        { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      ],
+      "triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+      "updateTime": "A String", # Output only. Last modified time of the execution.
+    },
+  ],
+  "nextPageToken": "A String", # The token used to retrieve the next page 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/integrations_v1alpha.projects.locations.integrations.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.html new file mode 100644 index 00000000000..fedbb9ed1bb --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.html @@ -0,0 +1,678 @@ + + + +

Application Integration API . projects . locations . integrations

+

Instance Methods

+

+ executions() +

+

Returns the executions Resource.

+ +

+ versions() +

+

Returns the versions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns the list of all integrations in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

+ monitorexecutionstats(parent, body=None, x__xgafv=None)

+

Get execution stats

+

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

+

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ execute(name, body=None, x__xgafv=None) +
Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
+
+Args:
+  name: string, Required. The integration resource name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for executing an integration.
+  "doNotPropagateError": True or False, # Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.
+  "executionId": "A String", # Optional. The id of the ON_HOLD execution to be resumed.
+  "inputParameters": { # Optional. Input parameters used by integration execution.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+  "parameterEntries": [ # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+  "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution. Redacted
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+      { # Key-value pair of EventBus parameters.
+        "dataType": "A String", # Explicitly getting the type of the parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+  "triggerId": "A String", # Optional. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for executing an integration.
+  "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed.
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+      { # Key-value pair of EventBus parameters.
+        "dataType": "A String", # Explicitly getting the type of the parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
+  "executionId": "A String", # The id of the execution corresponding to this run of integration.
+  "outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
+    "a_key": "", # Properties of the object.
+  },
+  "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all integrations in the specified project.
+
+Args:
+  parent: string, Required. Project and location from which the integrations should be listed. Format: projects/{project} (required)
+  filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+  orderBy: string, The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
+  pageSize: integer, The page size for the resquest.
+  pageToken: string, The page token for the resquest.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListIntegrations.
+  "integrations": [ # The integrations which match the request.
+    { # The integration definition.
+      "active": True or False, # Required. If any integration version is published.
+      "description": "A String", # Optional.
+      "name": "A String", # Required. The resource name of the integration.
+      "updateTime": "A String", # Output only. Auto-generated.
+    },
+  ],
+  "nextPageToken": "A String", # The next page token for the response.
+}
+
+ +
+ 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.
+        
+
+ +
+ monitorexecutionstats(parent, body=None, x__xgafv=None) +
Get execution stats
+
+Args:
+  parent: string, Required. The parent resource name: {parent=projects/*/locations/*}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to get data for monarch connector config.
+  "duration": "A String", # How long the series data range: "1h","1d",etc.
+  "endTime": "A String", # Final time to query over, or the current time if left unset.
+  "mashQuery": { # The MashQuery for searching data, set both queries for Join Operation. # Required. Query for searching data in monarch.
+    "firstQuery": { # The components for constructing MashQuery. # Required. The components for constructing a mash query. Set "point_operation" if this is a single query
+      "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+      "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+        "A String",
+      ],
+      "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+        "A String",
+      ],
+      "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+        "fields": [ # Optional. optional, metrics list for GroupBy.
+          "A String",
+        ],
+        "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+      },
+      "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+      "timeDelta": "A String", # Required. Window time delta.
+    },
+    "operationMode": { # Operation between 2 query # Optional. optional, only set when joining 2 queries. By default join 2 queries with join operation.
+      "joinConfig": { # Join Operation # Optional. join operation
+      },
+      "operationType": "A String", # Optional. optional operation types.
+      "unionConfig": { # Union operation # Optional. union operation
+        "reducer": "A String", # Optional. optional, reduce function
+      },
+    },
+    "secondQuery": { # The components for constructing MashQuery. # Optional. optional, only set when joining 2 queries. Set "point_operation" for joined query.
+      "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+      "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+        "A String",
+      ],
+      "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+        "A String",
+      ],
+      "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+        "fields": [ # Optional. optional, metrics list for GroupBy.
+          "A String",
+        ],
+        "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+      },
+      "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+      "timeDelta": "A String", # Required. Window time delta.
+    },
+  },
+  "metricFieldTable": True or False, # Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality.
+  "outputPeriod": "A String", # The output period for the query. Must be set if there is a window operation within the query and unset otherwise.
+  "responseTemplate": "A String", # Required. Template for response.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for getting Execution stats.
+  "aplosSeriesListData": { # Data used for Aplos charts that accept multiple Series. # List of points.
+    "series": [
+      {
+        "data": { # Data used to render an Aplos Series card.
+          "rows": [ # A single Series Row
+            { # Aplos series row is exactly two columns labeled x and y.
+              "x": {
+                "booleanValue": True or False,
+                "doubleValue": 3.14,
+                "empty": { # 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); }
+                },
+                "longValue": "A String",
+                "stringValue": "A String",
+              },
+              "y": {
+                "booleanValue": True or False,
+                "doubleValue": 3.14,
+                "empty": { # 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); }
+                },
+                "longValue": "A String",
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "name": "A String",
+      },
+    ],
+  },
+  "tableData": { # The generic data format returned from all connectors. # Data in form of table.
+    "headers": [ # Ordered list of column headers.
+      "A String",
+    ],
+    "rows": [ # Ordered list of table rows.
+      {
+        "cells": [ # Ordered list of cell values within a row.
+          {
+            "booleanValue": True or False,
+            "doubleValue": 3.14,
+            "empty": { # 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); }
+            },
+            "longValue": "A String",
+            "stringValue": "A String",
+          },
+        ],
+      },
+    ],
+  },
+}
+
+ +
+ schedule(name, body=None, x__xgafv=None) +
Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
+
+Args:
+  name: string, The integration resource name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for scheduling an integration.
+  "inputParameters": { # Optional. Input parameters used by integration execution.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+  "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+  "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each integration execution.
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+      { # Key-value pair of EventBus parameters.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "requestId": "A String", # This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+  "scheduleTime": "A String", # The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
+  "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for executing an integration.
+  "executionInfoIds": [ # The execution info id for the executed integrations.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html new file mode 100644 index 00000000000..1907ffeb8fe --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html @@ -0,0 +1,6369 @@ + + + +

Application Integration API . projects . locations . integrations . versions

+

Instance Methods

+

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

+

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, newIntegration=None, x__xgafv=None)

+

Create a integration with a draft version in the specified project.

+

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

+

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

+

+ get(name, x__xgafv=None)

+

Get a integration in the specified project.

+

+ list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns the list of all integration versions in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a integration with a draft version in the specified project.

+

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

+

This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.

+

+ takeoverEditLock(integrationVersion, body=None, x__xgafv=None)

+

Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.

+

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

+

Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.

+

Method Details

+
+ archive(name, body=None, x__xgafv=None) +
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
+
+Args:
+  name: string, Required. The version to archive. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for ArchiveIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ArchiveIntegrationVersion.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, newIntegration=None, x__xgafv=None) +
Create a integration with a draft version in the specified project.
+
+Args:
+  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+  newIntegration: boolean, Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+Args:
+  name: string, Required. The version to deactivate. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DeactivateIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for DeactivateIntegrationVersion.
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a integration in the specified project.
+
+Args:
+  name: string, Required. The version to retrieve. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all integration versions in the specified project.
+
+Args:
+  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client". (required)
+  fieldMask: string, The field mask which specifies the particular data to be returned.
+  filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+  orderBy: string, The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".
+  pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` 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 for ListIntegrationVersions.
+  "integrationVersions": [ # The integrations which match the request.
+    { # The integration version definition.
+      "createTime": "A String", # Output only. Auto-generated.
+      "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+      "description": "A String", # Optional. The integration description.
+      "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+        { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+          "dataType": "A String", # Type of the parameter.
+          "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+          "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter.
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "searchable": True or False, # Searchable in the execution log or not.
+        },
+      ],
+      "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+        "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+          {
+            "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+              "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+              "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+              "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+              "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+                "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+                "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+                  "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+                  "logType": [ # To which type(s) of logs the sanitize options apply.
+                    "A String",
+                  ],
+                  "privacy": "A String",
+                  "sanitizeType": "A String",
+                },
+                "seedPeriod": "A String",
+                "seedScope": "A String",
+                "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+                  "logAction": "A String",
+                  "logType": [ # To which type(s) of logs the limits apply.
+                    "A String",
+                  ],
+                  "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+                  "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+                  "shortenerType": "A String",
+                },
+              },
+              "searchable": "A String",
+              "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+                "A String",
+              ],
+            },
+            "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+              # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+            ],
+            "dataType": "A String", # The data type of the parameter.
+            "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "inOutType": "A String", # Specifies the input/output type for the parameter.
+            "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+            "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+            "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+              "elementIdentifier": "A String", # Configuration of the edge.
+              "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+            },
+            "producer": "A String",
+            "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+            "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+          },
+        ],
+      },
+      "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "name": "A String", # Output only. Auto-generated primary key.
+      "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+      "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+      "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+      "state": "A String", # Output only. User should not set it as an input.
+      "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+      "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+        { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+          "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+            "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+            "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+          "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+          "parameters": { # Optional. The customized parameters the user can pass to this task.
+            "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+            },
+          },
+          "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+            "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+          },
+          "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+            "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+            "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "task": "A String", # Optional. The name for the task.
+          "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+          "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+          "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+        },
+      ],
+      "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+        { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+          "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+            { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+              "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+              "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+              "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+              "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+              "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "errorEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+              "metricType": "A String",
+              "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+              "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+              "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+                "absolute": "A String",
+                "percentage": 42,
+              },
+              "warningEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+            },
+          ],
+          "createTime": "A String", # Auto-generated.
+          "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+          "description": "A String", # User-provided description intended to give more business context about the task.
+          "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+          "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+            "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+            "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+          "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+          "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+          "lastModifiedTime": "A String", # Auto-generated.
+          "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+                { # This message recursively combines constituent conditions using logical AND.
+                  "conditions": [ # A set of individual constituent conditions.
+                    { # Condition that uses `operator` to evaluate the key against the value.
+                      "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                      "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                      "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                        "booleanValue": True or False,
+                        "doubleArray": {
+                          "values": [
+                            3.14,
+                          ],
+                        },
+                        "doubleValue": 3.14,
+                        "intArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "intValue": "A String",
+                        "protoValue": {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                        "stringArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "stringValue": "A String",
+                      },
+                    },
+                  ],
+                },
+              ],
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+              "label": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskNumber": "A String", # Task number of the next task.
+            },
+          ],
+          "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+          "parameters": { # The customized parameters the user can pass to this task.
+            "a_key": { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          },
+          "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+            "x": 42,
+            "y": 42,
+          },
+          "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+          "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+          "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+                { # Key-value pair of EventBus parameters.
+                  "dataType": "A String", # Explicitly getting the type of the parameter.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                  "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+            "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+              "A String",
+            ],
+          },
+          "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+            "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+          },
+          "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+            "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+            "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+            "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+            "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+              "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+              "admins": [
+                { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+                  "googleGroupEmail": "A String",
+                  "userEmail": "A String",
+                },
+              ],
+              "category": "A String",
+              "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+              "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+              "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+              "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+              "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+              "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+              "externalCategory": "A String",
+              "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+              "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+              "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+              "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+              "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+              "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+              "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+              "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+              "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+              "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+              "system": "A String",
+              "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+                "A String",
+              ],
+            },
+            "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+              "parameters": [
+                { # Key-value pair of EventBus task parameters. Next id: 13
+                  "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+                  "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+                  "config": { # Optional fields, such as help text and other useful info.
+                    "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                    "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                    "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                    "inputDisplayOption": "A String",
+                    "isHidden": True or False, # Whether this field is hidden in the UI.
+                    "label": "A String", # A user-friendly label for the parameter.
+                    "parameterNameOption": "A String",
+                    "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                    "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+                  },
+                  "dataType": "A String", # The data type of the parameter.
+                  "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                  "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+                  "isOutput": True or False,
+                  "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+                  "protoDef": { # Populated if this represents a proto or proto array.
+                    "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                    "path": "A String", # Path to the proto file that contains the message type's definition.
+                  },
+                  "required": True or False, # If set, the user must provide an input value for this parameter.
+                  "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                    "doubleRange": { # Range used to validate doubles and floats.
+                      "max": 3.14, # The inclusive maximum of the acceptable range.
+                      "min": 3.14, # The inclusive minimum of the acceptable range.
+                    },
+                    "intRange": { # Range used to validate longs and ints.
+                      "max": "A String", # The inclusive maximum of the acceptable range.
+                      "min": "A String", # The inclusive minimum of the acceptable range.
+                    },
+                    "stringRegex": { # Rule used to validate strings.
+                      "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                      "regex": "A String", # The regex applied to the input value(s).
+                    },
+                  },
+                },
+              ],
+            },
+            "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+              "dimensions": { # Dimensions that these stats have been aggregated on.
+                "clientId": "A String",
+                "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+                "errorEnumString": "A String",
+                "retryAttempt": "A String",
+                "taskName": "A String",
+                "taskNumber": "A String",
+                "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+                "warningEnumString": "A String",
+                "workflowId": "A String",
+                "workflowName": "A String",
+              },
+              "durationInSeconds": 3.14, # Average duration in seconds.
+              "errorRate": 3.14, # Average error rate.
+              "qps": 3.14, # Queries per second.
+              "warningRate": 3.14, # Average warning rate.
+            },
+            "taskType": "A String", # Defines the type of the task
+            "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+              "taskUiModuleConfigs": [ # Configurations of included config modules.
+                { # Task author would use this type to configure a config module.
+                  "moduleId": "A String", # ID of the config module.
+                },
+              ],
+            },
+          },
+          "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+          "taskName": "A String", # The name for the task.
+          "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+          "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+          "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+          "taskType": "A String", # Defines the type of the task
+        },
+      ],
+      "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+        "teardownTaskConfigs": [ # Required.
+          {
+            "creatorEmail": "A String", # The creator's email address.
+            "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+            "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+              "name": "A String", # Required. Name of the next teardown task.
+            },
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+              "properties": [ # An unordered list of property entries.
+                { # Key-value pair of EventBus property.
+                  "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+          },
+        ],
+      },
+      "triggerConfigs": [ # Optional. Trigger configurations.
+        { # Configuration detail of a trigger.
+          "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+            { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+              "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+              "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+              "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+              "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "metricType": "A String", # The type of metric.
+              "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+              "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+                "absolute": "A String", # Absolute value threshold.
+                "percentage": 42, # Percentage threshold.
+              },
+            },
+          ],
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "label": "A String", # Optional. The user created label for a particular trigger.
+          "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+          "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+            "a_key": "A String",
+          },
+          "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "triggerId": "A String", # Optional. The backend trigger ID.
+          "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+          "triggerType": "A String", # Optional. Type of trigger
+        },
+      ],
+      "triggerConfigsInternal": [ # Optional. Trigger configurations.
+        { # Configuration detail of a trigger. Next available id: 16
+          "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+            { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+              "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+              "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+              "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+              "clientId": "A String", # Client associated with this alert configuration.
+              "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "errorEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+              "metricType": "A String",
+              "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+              "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+              "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+                "absolute": "A String",
+                "percentage": 42,
+              },
+              "warningEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+            },
+          ],
+          "description": "A String", # User-provided description intended to give more business context about the task.
+          "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+            "A String",
+          ],
+          "label": "A String", # The user created label for a particular trigger.
+          "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+          "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+          "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+            "x": 42,
+            "y": 42,
+          },
+          "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+            "a_key": "A String",
+          },
+          "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+                { # This message recursively combines constituent conditions using logical AND.
+                  "conditions": [ # A set of individual constituent conditions.
+                    { # Condition that uses `operator` to evaluate the key against the value.
+                      "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                      "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                      "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                        "booleanValue": True or False,
+                        "doubleArray": {
+                          "values": [
+                            3.14,
+                          ],
+                        },
+                        "doubleValue": 3.14,
+                        "intArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "intValue": "A String",
+                        "protoValue": {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                        "stringArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "stringValue": "A String",
+                      },
+                    },
+                  ],
+                },
+              ],
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+              "label": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskNumber": "A String", # Task number of the next task.
+            },
+          ],
+          "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+            "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+          },
+          "triggerId": "A String", # The backend trigger ID.
+          "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+          "triggerType": "A String",
+        },
+      ],
+      "updateTime": "A String", # Output only. Auto-generated.
+      "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+    },
+  ],
+  "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.
+  "noPermission": True or False, # Whether the user has no permission on the version or not.
+}
+
+ +
+ 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) +
Update a integration with a draft version in the specified project.
+
+Args:
+  name: string, Output only. Auto-generated primary key. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+  updateMask: string, Field mask specifying the fields in the above integration that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ publish(name, body=None, x__xgafv=None) +
This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
+
+Args:
+  name: string, Required. The version to publish. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for PublishIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for PublishIntegrationVersion.
+}
+
+ +
+ takeoverEditLock(integrationVersion, body=None, x__xgafv=None) +
Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.
+
+Args:
+  integrationVersion: string, Required. The version to take over edit lock. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for TakeoverEditLock.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for TakeoverEditLock.
+  "integrationVersion": { # The integration version definition. # Version after the lock is acquired by the new user.
+    "createTime": "A String", # Output only. Auto-generated.
+    "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+    "description": "A String", # Optional. The integration description.
+    "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+        "dataType": "A String", # Type of the parameter.
+        "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+        "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter.
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+        "searchable": True or False, # Searchable in the execution log or not.
+      },
+    ],
+    "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+        {
+          "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+            "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+            "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+              "booleanValue": True or False,
+              "doubleArray": {
+                "values": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "stringArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+            "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+            "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+              "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+              "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+                "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+                "logType": [ # To which type(s) of logs the sanitize options apply.
+                  "A String",
+                ],
+                "privacy": "A String",
+                "sanitizeType": "A String",
+              },
+              "seedPeriod": "A String",
+              "seedScope": "A String",
+              "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+                "logAction": "A String",
+                "logType": [ # To which type(s) of logs the limits apply.
+                  "A String",
+                ],
+                "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+                "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+                "shortenerType": "A String",
+              },
+            },
+            "searchable": "A String",
+            "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+              "A String",
+            ],
+          },
+          "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+            # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+          ],
+          "dataType": "A String", # The data type of the parameter.
+          "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "inOutType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+            "elementIdentifier": "A String", # Configuration of the edge.
+            "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+          },
+          "producer": "A String",
+          "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+          "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+        },
+      ],
+    },
+    "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "name": "A String", # Output only. Auto-generated primary key.
+    "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+    "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+    "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+    "state": "A String", # Output only. User should not set it as an input.
+    "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+    "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+        "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # Optional. The customized parameters the user can pass to this task.
+          "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "task": "A String", # Optional. The name for the task.
+        "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+        "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+        "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+      },
+    ],
+    "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+        "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+          { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+            "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+            "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "createTime": "A String", # Auto-generated.
+        "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+        "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+        "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+        "lastModifiedTime": "A String", # Auto-generated.
+        "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # The customized parameters the user can pass to this task.
+          "a_key": { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        },
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+        "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+        "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+              { # Key-value pair of EventBus parameters.
+                "dataType": "A String", # Explicitly getting the type of the parameter.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+          "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+            "A String",
+          ],
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+          "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+          "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+            "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+            "admins": [
+              { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+                "googleGroupEmail": "A String",
+                "userEmail": "A String",
+              },
+            ],
+            "category": "A String",
+            "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+            "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+            "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+            "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+            "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+            "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+            "externalCategory": "A String",
+            "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+            "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+            "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+            "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+            "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+            "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+            "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+            "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+            "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+            "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+            "system": "A String",
+            "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+              "A String",
+            ],
+          },
+          "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+            "parameters": [
+              { # Key-value pair of EventBus task parameters. Next id: 13
+                "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+                "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+                "config": { # Optional fields, such as help text and other useful info.
+                  "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                  "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                  "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                  "inputDisplayOption": "A String",
+                  "isHidden": True or False, # Whether this field is hidden in the UI.
+                  "label": "A String", # A user-friendly label for the parameter.
+                  "parameterNameOption": "A String",
+                  "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                  "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+                },
+                "dataType": "A String", # The data type of the parameter.
+                "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+                "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+                "isOutput": True or False,
+                "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+                "protoDef": { # Populated if this represents a proto or proto array.
+                  "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                  "path": "A String", # Path to the proto file that contains the message type's definition.
+                },
+                "required": True or False, # If set, the user must provide an input value for this parameter.
+                "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                  "doubleRange": { # Range used to validate doubles and floats.
+                    "max": 3.14, # The inclusive maximum of the acceptable range.
+                    "min": 3.14, # The inclusive minimum of the acceptable range.
+                  },
+                  "intRange": { # Range used to validate longs and ints.
+                    "max": "A String", # The inclusive maximum of the acceptable range.
+                    "min": "A String", # The inclusive minimum of the acceptable range.
+                  },
+                  "stringRegex": { # Rule used to validate strings.
+                    "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                    "regex": "A String", # The regex applied to the input value(s).
+                  },
+                },
+              },
+            ],
+          },
+          "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+            "dimensions": { # Dimensions that these stats have been aggregated on.
+              "clientId": "A String",
+              "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+              "errorEnumString": "A String",
+              "retryAttempt": "A String",
+              "taskName": "A String",
+              "taskNumber": "A String",
+              "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+              "warningEnumString": "A String",
+              "workflowId": "A String",
+              "workflowName": "A String",
+            },
+            "durationInSeconds": 3.14, # Average duration in seconds.
+            "errorRate": 3.14, # Average error rate.
+            "qps": 3.14, # Queries per second.
+            "warningRate": 3.14, # Average warning rate.
+          },
+          "taskType": "A String", # Defines the type of the task
+          "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+            "taskUiModuleConfigs": [ # Configurations of included config modules.
+              { # Task author would use this type to configure a config module.
+                "moduleId": "A String", # ID of the config module.
+              },
+            ],
+          },
+        },
+        "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+        "taskName": "A String", # The name for the task.
+        "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+        "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+        "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+        "taskType": "A String", # Defines the type of the task
+      },
+    ],
+    "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+      "teardownTaskConfigs": [ # Required.
+        {
+          "creatorEmail": "A String", # The creator's email address.
+          "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+          "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+            "name": "A String", # Required. Name of the next teardown task.
+          },
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+            "properties": [ # An unordered list of property entries.
+              { # Key-value pair of EventBus property.
+                "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+                "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "values": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "stringArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+        },
+      ],
+    },
+    "triggerConfigs": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger.
+        "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+            "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+            "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "metricType": "A String", # The type of metric.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String", # Absolute value threshold.
+              "percentage": 42, # Percentage threshold.
+            },
+          },
+        ],
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "label": "A String", # Optional. The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+        "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "triggerId": "A String", # Optional. The backend trigger ID.
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+        "triggerType": "A String", # Optional. Type of trigger
+      },
+    ],
+    "triggerConfigsInternal": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger. Next available id: 16
+        "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+            "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+            "clientId": "A String", # Client associated with this alert configuration.
+            "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+          "A String",
+        ],
+        "label": "A String", # The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+        "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+          "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+        },
+        "triggerId": "A String", # The backend trigger ID.
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+        "triggerType": "A String",
+      },
+    ],
+    "updateTime": "A String", # Output only. Auto-generated.
+    "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+  },
+}
+
+ +
+ validate(name, body=None, x__xgafv=None) +
Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
+
+Args:
+  name: string, Required. The version to validate. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for ValidateIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ValidateIntegrationVersion.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html b/docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html new file mode 100644 index 00000000000..f83cb3f8ad2 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.authConfigs.html @@ -0,0 +1,2420 @@ + + + +

Application Integration API . projects . locations . products . authConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, x__xgafv=None)

+

Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.

+

+ delete(name, x__xgafv=None)

+

Deletes an auth config.

+

+ get(name, x__xgafv=None)

+

Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None)

+

Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, x__xgafv=None) +
Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
+
+Args:
+  parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+  clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+  clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an auth config.
+
+Args:
+  name: string, Required. The name that is associated with the AuthConfig. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
+
+Args:
+  name: string, Required. The name that is associated with the AuthConfig. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
+
+Args:
+  parent: string, Required. The client, which owns this collection of AuthConfigs. (required)
+  filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+  pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+  pageToken: string, The token returned in the previous response.
+  readMask: string, The mask which specifies fields that need to be returned in the AuthConfig's response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list AuthConfigs.
+  "authConfigs": [ # The list of AuthConfigs retrieved.
+    { # The AuthConfig resource use to hold channels and connection config data.
+      "certificateId": "A String", # Certificate id for client certificate
+      "createTime": "A String", # Output only. The timestamp when the auth config is created.
+      "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "credentialType": "A String", # Credential type of the encrypted credential.
+      "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+        "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+          "token": "A String", # The token for the auth type.
+          "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+        },
+        "credentialType": "A String", # Credential type associated with auth config.
+        "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+          "jwt": "A String", # The token calculated by the header, payload and signature.
+          "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+          "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+          "secret": "A String", # User's pre-shared secret to sign the token.
+        },
+        "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+          "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+            "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+            "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+            "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+            "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+            "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+          },
+          "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+          "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+          "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+          "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+          "clientId": "A String", # The client's id.
+          "clientSecret": "A String", # The client's secret.
+          "requestType": "A String", # Represent how to pass parameters to fetch access token
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+          "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+        },
+        "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+          "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+            "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+            "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+            "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+            "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+            "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+          },
+          "clientId": "A String", # The client's ID.
+          "clientSecret": "A String", # The client's secret.
+          "requestType": "A String", # Represent how to pass parameters to fetch access token
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+          "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+        },
+        "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+          "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+            "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+            "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+            "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+            "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+            "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+          },
+          "clientId": "A String", # The client's ID.
+          "clientSecret": "A String", # The client's secret.
+          "password": "A String", # The user's password.
+          "requestType": "A String", # Represent how to pass parameters to fetch access token
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+          "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+            "entries": [ # A list of parameter map entries.
+              { # Entry is a pair of key and value.
+                "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+                "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+                  "literalValue": { # The type of the parameter. # Passing a literal value.
+                    "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                      "booleanValues": [ # Boolean array.
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False, # Boolean.
+                    "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                      "doubleValues": [ # Double number array.
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14, # Double Number.
+                    "intArray": { # This message only contains a field of integer array. # Integer Array.
+                      "intValues": [ # Integer array.
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String", # Integer.
+                    "jsonValue": "A String", # Json.
+                    "stringArray": { # This message only contains a field of string array. # String Array.
+                      "stringValues": [ # String array.
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String", # String.
+                  },
+                  "referenceKey": "A String", # Referencing one of the Integration variables.
+                },
+              },
+            ],
+            "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+            "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+          },
+          "username": "A String", # The user's username.
+        },
+        "oidcToken": { # OIDC Token # Google OIDC ID Token
+          "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+          "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+          "token": "A String", # ID token obtained for the service account
+          "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+        },
+        "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+          "scope": "A String", # A space-delimited list of requested scope permissions.
+          "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+        },
+        "usernameAndPassword": { # Username and password pair. # Username and password credential
+          "password": "A String", # Password to be used
+          "username": "A String", # Username to be used
+        },
+      },
+      "description": "A String", # A description of the auth config.
+      "displayName": "A String", # The name of the auth config.
+      "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+      "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+        "A String",
+      ],
+      "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+      "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+      "reason": "A String", # The reason / details of the current status.
+      "state": "A String", # The status of the auth config.
+      "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+      "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+      "visibility": "A String", # The visibility of the auth config.
+    },
+  ],
+  "nextPageToken": "A String", # The token used 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(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None) +
Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
+
+Args:
+  name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+  clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+  clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  updateMask: string, Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The AuthConfig resource use to hold channels and connection config data.
+  "certificateId": "A String", # Certificate id for client certificate
+  "createTime": "A String", # Output only. The timestamp when the auth config is created.
+  "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "credentialType": "A String", # Credential type of the encrypted credential.
+  "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+    "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+      "token": "A String", # The token for the auth type.
+      "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+    },
+    "credentialType": "A String", # Credential type associated with auth config.
+    "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+      "jwt": "A String", # The token calculated by the header, payload and signature.
+      "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+      "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+      "secret": "A String", # User's pre-shared secret to sign the token.
+    },
+    "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+      "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+      "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+      "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "clientId": "A String", # The client's id.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+    },
+    "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+      "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+        "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+        "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+        "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+        "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+        "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+      },
+      "clientId": "A String", # The client's ID.
+      "clientSecret": "A String", # The client's secret.
+      "password": "A String", # The user's password.
+      "requestType": "A String", # Represent how to pass parameters to fetch access token
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+      "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+        "entries": [ # A list of parameter map entries.
+          { # Entry is a pair of key and value.
+            "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+            "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+              "literalValue": { # The type of the parameter. # Passing a literal value.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "referenceKey": "A String", # Referencing one of the Integration variables.
+            },
+          },
+        ],
+        "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+        "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+      },
+      "username": "A String", # The user's username.
+    },
+    "oidcToken": { # OIDC Token # Google OIDC ID Token
+      "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+      "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+      "token": "A String", # ID token obtained for the service account
+      "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+    },
+    "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+      "scope": "A String", # A space-delimited list of requested scope permissions.
+      "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+    },
+    "usernameAndPassword": { # Username and password pair. # Username and password credential
+      "password": "A String", # Password to be used
+      "username": "A String", # Username to be used
+    },
+  },
+  "description": "A String", # A description of the auth config.
+  "displayName": "A String", # The name of the auth config.
+  "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+  "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+    "A String",
+  ],
+  "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+  "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+  "reason": "A String", # The reason / details of the current status.
+  "state": "A String", # The status of the auth config.
+  "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+  "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+  "visibility": "A String", # The visibility of the auth config.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.certificates.html b/docs/dyn/integrations_v1alpha.projects.locations.products.certificates.html new file mode 100644 index 00000000000..f3791bf49d4 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.certificates.html @@ -0,0 +1,308 @@ + + + +

Application Integration API . projects . locations . products . certificates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.

+

+ delete(name, x__xgafv=None)

+

Delete a certificate

+

+ get(name, x__xgafv=None)

+

Get a certificates in the specified project.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

List all the certificates that match the filter. Restrict to certificate of current client only.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
+
+Args:
+  parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The certificate definition
+  "certificateStatus": "A String", # Status of the certificate
+  "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+  "description": "A String", # Description of the certificate
+  "displayName": "A String", # Name of the certificate
+  "name": "A String", # Output only. Auto generated primary key
+  "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+    "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+    "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+    "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  },
+  "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+  "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+  "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The certificate definition
+  "certificateStatus": "A String", # Status of the certificate
+  "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+  "description": "A String", # Description of the certificate
+  "displayName": "A String", # Name of the certificate
+  "name": "A String", # Output only. Auto generated primary key
+  "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+    "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+    "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+    "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  },
+  "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+  "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+  "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete a certificate
+
+Args:
+  name: string, Required. The name that is associated with the Certificate. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a certificates in the specified project.
+
+Args:
+  name: string, Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The certificate definition
+  "certificateStatus": "A String", # Status of the certificate
+  "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+  "description": "A String", # Description of the certificate
+  "displayName": "A String", # Name of the certificate
+  "name": "A String", # Output only. Auto generated primary key
+  "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+    "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+    "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+    "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  },
+  "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+  "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+  "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
List all the certificates that match the filter. Restrict to certificate of current client only.
+
+Args:
+  parent: string, Required. The client, which owns this collection of Certificates. (required)
+  filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+  pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+  pageToken: string, The token returned in the previous response.
+  readMask: string, The mask which specifies fields that need to be returned in the Certificate's response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list Certificates.
+  "certificates": [ # The list of Certificates retrieved.
+    { # The certificate definition
+      "certificateStatus": "A String", # Status of the certificate
+      "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+      "description": "A String", # Description of the certificate
+      "displayName": "A String", # Name of the certificate
+      "name": "A String", # Output only. Auto generated primary key
+      "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+        "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+        "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+        "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+      },
+      "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+      "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+      "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+    },
+  ],
+  "nextPageToken": "A String", # The token used 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(name, body=None, updateMask=None, x__xgafv=None) +
Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
+
+Args:
+  name: string, Output only. Auto generated primary key (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The certificate definition
+  "certificateStatus": "A String", # Status of the certificate
+  "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+  "description": "A String", # Description of the certificate
+  "displayName": "A String", # Name of the certificate
+  "name": "A String", # Output only. Auto generated primary key
+  "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+    "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+    "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+    "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  },
+  "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+  "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+  "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+  updateMask: string, Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The certificate definition
+  "certificateStatus": "A String", # Status of the certificate
+  "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+  "description": "A String", # Description of the certificate
+  "displayName": "A String", # Name of the certificate
+  "name": "A String", # Output only. Auto generated primary key
+  "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+    "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+    "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+    "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+  },
+  "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+  "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+  "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.html b/docs/dyn/integrations_v1alpha.projects.locations.products.html new file mode 100644 index 00000000000..87b6991b8b2 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.html @@ -0,0 +1,316 @@ + + + +

Application Integration API . projects . locations . products

+

Instance Methods

+

+ authConfigs() +

+

Returns the authConfigs Resource.

+ +

+ certificates() +

+

Returns the certificates Resource.

+ +

+ integrations() +

+

Returns the integrations Resource.

+ +

+ integrationtemplates() +

+

Returns the integrationtemplates Resource.

+ +

+ sfdcInstances() +

+

Returns the sfdcInstances Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ createBundle(parent, body=None, x__xgafv=None)

+

PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.

+

+ listTaskEntities(parent, x__xgafv=None)

+

This is a UI only method and will be moved away. Returns a list of common tasks.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ createBundle(parent, body=None, x__xgafv=None) +
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
+
+Args:
+  parent: string, Required. The location resource of the request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request to create a new Bundle.
+  "bundleId": "A String", # Required. name of the bundle that will be created
+  "integrations": [ # A list of integrations that can be executed by the bundle
+    "A String",
+  ],
+  "secondaryCustomerOrgId": "A String", # Optional. The prefix for the SA, it should be in the format "o". This is an optional field, and if empty service account will be created per project, where we are creating bundle. This should only be used as the org ID for which we want to run the integrations in the bundle.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for create bundle.
+  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the bundle data
+    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+      "A String",
+    ],
+    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+  },
+  "triggerId": "A String", # trigger_id of the bundle task
+}
+
+ +
+ listTaskEntities(parent, x__xgafv=None) +
This is a UI only method and will be moved away. Returns a list of common tasks.
+
+Args:
+  parent: string, Required. The location resource of the request. This is not going to be used but preserve the field for future. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This is a UI only method and will be moved away. Response for ListTaskEntities.
+  "taskEntities": [ # The list of the tasks.
+    { # Contains a task's metadata and associated information. Next available id: 7
+      "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+      "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+        "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+        "admins": [
+          { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+            "googleGroupEmail": "A String",
+            "userEmail": "A String",
+          },
+        ],
+        "category": "A String",
+        "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+        "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+        "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+        "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+        "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+        "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+        "externalCategory": "A String",
+        "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+        "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+        "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+        "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+        "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+        "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+        "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+        "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+        "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+        "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+        "system": "A String",
+        "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+          "A String",
+        ],
+      },
+      "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+        "parameters": [
+          { # Key-value pair of EventBus task parameters. Next id: 13
+            "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+            "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+            "config": { # Optional fields, such as help text and other useful info.
+              "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+              "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+              "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+              "inputDisplayOption": "A String",
+              "isHidden": True or False, # Whether this field is hidden in the UI.
+              "label": "A String", # A user-friendly label for the parameter.
+              "parameterNameOption": "A String",
+              "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+              "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+            },
+            "dataType": "A String", # The data type of the parameter.
+            "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+            "isOutput": True or False,
+            "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+            "protoDef": { # Populated if this represents a proto or proto array.
+              "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+              "path": "A String", # Path to the proto file that contains the message type's definition.
+            },
+            "required": True or False, # If set, the user must provide an input value for this parameter.
+            "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+              "doubleRange": { # Range used to validate doubles and floats.
+                "max": 3.14, # The inclusive maximum of the acceptable range.
+                "min": 3.14, # The inclusive minimum of the acceptable range.
+              },
+              "intRange": { # Range used to validate longs and ints.
+                "max": "A String", # The inclusive maximum of the acceptable range.
+                "min": "A String", # The inclusive minimum of the acceptable range.
+              },
+              "stringRegex": { # Rule used to validate strings.
+                "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                "regex": "A String", # The regex applied to the input value(s).
+              },
+            },
+          },
+        ],
+      },
+      "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+        "dimensions": { # Dimensions that these stats have been aggregated on.
+          "clientId": "A String",
+          "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+          "errorEnumString": "A String",
+          "retryAttempt": "A String",
+          "taskName": "A String",
+          "taskNumber": "A String",
+          "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+          "warningEnumString": "A String",
+          "workflowId": "A String",
+          "workflowName": "A String",
+        },
+        "durationInSeconds": 3.14, # Average duration in seconds.
+        "errorRate": 3.14, # Average error rate.
+        "qps": 3.14, # Queries per second.
+        "warningRate": 3.14, # Average warning rate.
+      },
+      "taskType": "A String", # Defines the type of the task
+      "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+        "taskUiModuleConfigs": [ # Configurations of included config modules.
+          { # Task author would use this type to configure a config module.
+            "moduleId": "A String", # ID of the config module.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html new file mode 100644 index 00000000000..6e94057e9d0 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.html @@ -0,0 +1,1197 @@ + + + +

Application Integration API . projects . locations . products . integrations . executions

+

Instance Methods

+

+ suspensions() +

+

Returns the suspensions Resource.

+ +

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

+

Cancellation of an execution

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get an execution in the specified project.

+

+ list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_triggerId=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, truncateParams=None, x__xgafv=None)

+

Lists the status of the integration executions.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Cancellation of an execution
+
+Args:
+  name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for cancelling an execution.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for cancelling an execution.
+  "isCanceled": True or False, # True if cancellation performed successfully
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get an execution in the specified project.
+
+Args:
+  name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The Execution resource contains detailed information of an individual integration execution.
+  "createTime": "A String", # Output only. Created time of the execution.
+  "directSubExecutions": [ # Direct sub executions of the following Execution.
+    # Object with schema name: GoogleCloudIntegrationsV1alphaExecution
+  ],
+  "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+    "eventAttemptStats": [
+      {
+        "endTime": "A String", # The end time of the event execution for current attempt.
+        "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+      },
+    ],
+    "eventExecutionSnapshot": [
+      { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+        "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+        "conditionResults": [ # All of the computed conditions that been calculated.
+          { # Contains the combined condition calculation results.
+            "currentTaskNumber": "A String", # the current task number.
+            "nextTaskNumber": "A String", # the next task number.
+            "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+          },
+        ],
+        "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+        "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+        "eventExecutionSnapshotMetadata": {
+          "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+          "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+          "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+          "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+        },
+        "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+        "snapshotTime": "A String", # Indicates when this snapshot is taken.
+        "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+          { # Contains the details of the execution of this task. Next available id: 11
+            "taskAttemptStats": [
+              {
+                "endTime": "A String", # The end time of the task execution for current attempt.
+                "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+              },
+            ],
+            "taskExecutionState": "A String",
+            "taskNumber": "A String", # Pointer to the task config it used for execution.
+          },
+        ],
+        "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+      },
+    ],
+    "eventExecutionState": "A String",
+    "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+    "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+    "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+    "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+    "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+  },
+  "executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
+    "attemptStats": [ # List of Start and end time of the execution attempts.
+      { # Status for the execution attempt.
+        "endTime": "A String", # The end time of the event execution for current attempt.
+        "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+      },
+    ],
+    "executionSnapshots": [ # List of snapshots taken during the execution.
+      { # Contains the snapshot of the execution for a given checkpoint.
+        "checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
+        "executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
+          "executionAttempt": 42, # the execution attempt number this snapshot belongs to.
+          "task": "A String", # the task name associated with this snapshot.
+          "taskAttempt": 42, # the task attempt number this snapshot belongs to.
+          "taskNumber": "A String", # The task number associated with this snapshot.
+        },
+        "params": { # Parameters used during the execution.
+          "a_key": { # The type of the parameter.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+        "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+          { # Contains the details of the execution of this task.
+            "taskAttemptStats": [ # Status for the current task execution attempt.
+              { # Status for the execution attempt.
+                "endTime": "A String", # The end time of the event execution for current attempt.
+                "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+              },
+            ],
+            "taskExecutionState": "A String", # The execution state of this task.
+            "taskNumber": "A String", # Pointer to the task config it used for execution.
+          },
+        ],
+      },
+    ],
+    "state": "A String", # Status of the execution.
+  },
+  "executionMethod": "A String", # The ways user posts this event.
+  "name": "A String", # Auto-generated primary key.
+  "requestParameters": { # Event parameters come in as part of the request.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+  "requestParams": [ # Event parameters come in as part of the request.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+  "responseParameters": { # Event parameters returned as part of the response.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+  "responseParams": [ # Event parameters come out as part of the response.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+  "triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+  "updateTime": "A String", # Output only. Last modified time of the execution.
+}
+
+ +
+ list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_triggerId=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, truncateParams=None, x__xgafv=None) +
Lists the status of the integration executions.
+
+Args:
+  parent: string, Required. The parent resource name of the integration execution. (required)
+  filter: string, Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
+  filterParams_customFilter: string, Optional user-provided custom filter.
+  filterParams_endTime: string, End timestamp.
+  filterParams_eventStatuses: string, List of possible event statuses. (repeated)
+  filterParams_executionId: string, Execution id.
+  filterParams_parameterKey: string, Param key. DEPRECATED. User parameter_pair_key instead.
+  filterParams_parameterPairKey: string, Param key in the key value pair filter.
+  filterParams_parameterPairValue: string, Param value in the key value pair filter.
+  filterParams_parameterType: string, Param type.
+  filterParams_parameterValue: string, Param value. DEPRECATED. User parameter_pair_value instead.
+  filterParams_startTime: string, Start timestamp.
+  filterParams_taskStatuses: string, List of possible task statuses. (repeated)
+  filterParams_triggerId: string, Trigger id.
+  filterParams_workflowName: string, Workflow name.
+  orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
+  pageSize: integer, Optional. The size of entries in the response.
+  pageToken: string, Optional. The token returned in the previous response.
+  readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.
+  refreshAcl: boolean, Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
+  truncateParams: boolean, Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for listing the integration execution data.
+  "executionInfos": [ # Required. The detailed information of requested executions.
+    { # Contains all the execution details for a workflow instance. Next available id: 24
+      "clientId": "A String", # The event data user sends as request.
+      "createTime": "A String", # Auto-generated.
+      "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # Final error-code if event failed.
+        "commonErrorCode": "A String",
+      },
+      "errors": [ # Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.
+        { # An error, warning, or information message associated with a workflow.
+          "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # The associated error-code, which can be a common or internal code.
+            "commonErrorCode": "A String",
+          },
+          "errorMessage": "A String", # The full text of the error message, including any parameters that were thrown along with the exception.
+          "severity": "A String", # The severity of the error: ERROR|WARN|INFO.
+          "taskNumber": 42, # The task try-number, in which, the error occurred. If zero, the error happened at the event level.
+        },
+      ],
+      "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+        "eventAttemptStats": [
+          {
+            "endTime": "A String", # The end time of the event execution for current attempt.
+            "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+          },
+        ],
+        "eventExecutionSnapshot": [ # After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible.
+          {
+            "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+            "conditionResults": [ # All of the computed conditions that been calculated.
+              { # Contains the combined condition calculation results.
+                "currentTaskNumber": "A String", # the current task number.
+                "nextTaskNumber": "A String", # the next task number.
+                "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+              },
+            ],
+            "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+                { # Key-value pair of EventBus parameters.
+                  "dataType": "A String", # Explicitly getting the type of the parameter.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                  "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+            "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+            "eventExecutionSnapshotMetadata": {
+              "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+              "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+              "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+              "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+            },
+            "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+                { # Key-value pair of EventBus parameters.
+                  "dataType": "A String", # Explicitly getting the type of the parameter.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                  "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "snapshotTime": "A String", # Indicates when this snapshot is taken.
+            "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+              { # Contains the details of the execution of this task. Next available id: 11
+                "taskAttemptStats": [
+                  {
+                    "endTime": "A String", # The end time of the task execution for current attempt.
+                    "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+                  },
+                ],
+                "taskExecutionState": "A String",
+                "taskNumber": "A String", # Pointer to the task config it used for execution.
+              },
+            ],
+            "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+          },
+        ],
+        "eventExecutionState": "A String", # The execution state of this event.
+        "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+        "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+        "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+        "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+        "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+      },
+      "eventExecutionInfoId": "A String", # Auto-generated primary key.
+      "executionTraceInfo": { # Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships. # Execution trace info to aggregate parent-child executions.
+        "parentEventExecutionInfoId": "A String", # Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.
+        "traceId": "A String", # Used to aggregate ExecutionTraceInfo.
+      },
+      "lastModifiedTime": "A String", # Auto-generated.
+      "postMethod": "A String", # The ways user posts this event.
+      "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default.
+      "requestId": "A String", # Optional. This is used to de-dup incoming request.
+      "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come in as part of the request.
+        "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+          { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        ],
+      },
+      "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come out as part of the response.
+        "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+          { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        ],
+      },
+      "snapshotNumber": "A String", # Workflow snapshot number.
+      "tenant": "A String", # Tenant this event is created. Used to reschedule the event to correct tenant.
+      "triggerId": "A String", # The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+      "workflowId": "A String", # Required. Pointer to the workflow it is executing.
+      "workflowName": "A String", # Name of the workflow.
+      "workflowRetryBackoffIntervalSeconds": "A String", # Time interval in seconds to schedule retry of workflow in manifold when workflow is already running
+    },
+  ],
+  "executions": [ # The detailed information of requested executions
+    { # The Execution resource contains detailed information of an individual integration execution.
+      "createTime": "A String", # Output only. Created time of the execution.
+      "directSubExecutions": [ # Direct sub executions of the following Execution.
+        # Object with schema name: GoogleCloudIntegrationsV1alphaExecution
+      ],
+      "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+        "eventAttemptStats": [
+          {
+            "endTime": "A String", # The end time of the event execution for current attempt.
+            "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+          },
+        ],
+        "eventExecutionSnapshot": [
+          { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+            "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+            "conditionResults": [ # All of the computed conditions that been calculated.
+              { # Contains the combined condition calculation results.
+                "currentTaskNumber": "A String", # the current task number.
+                "nextTaskNumber": "A String", # the next task number.
+                "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+              },
+            ],
+            "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+            "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+            "eventExecutionSnapshotMetadata": {
+              "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+              "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+              "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+              "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+            },
+            "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+            "snapshotTime": "A String", # Indicates when this snapshot is taken.
+            "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+              { # Contains the details of the execution of this task. Next available id: 11
+                "taskAttemptStats": [
+                  {
+                    "endTime": "A String", # The end time of the task execution for current attempt.
+                    "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+                  },
+                ],
+                "taskExecutionState": "A String",
+                "taskNumber": "A String", # Pointer to the task config it used for execution.
+              },
+            ],
+            "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+          },
+        ],
+        "eventExecutionState": "A String",
+        "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+        "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+        "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+        "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+        "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+      },
+      "executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
+        "attemptStats": [ # List of Start and end time of the execution attempts.
+          { # Status for the execution attempt.
+            "endTime": "A String", # The end time of the event execution for current attempt.
+            "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+          },
+        ],
+        "executionSnapshots": [ # List of snapshots taken during the execution.
+          { # Contains the snapshot of the execution for a given checkpoint.
+            "checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
+            "executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
+              "executionAttempt": 42, # the execution attempt number this snapshot belongs to.
+              "task": "A String", # the task name associated with this snapshot.
+              "taskAttempt": 42, # the task attempt number this snapshot belongs to.
+              "taskNumber": "A String", # The task number associated with this snapshot.
+            },
+            "params": { # Parameters used during the execution.
+              "a_key": { # The type of the parameter.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+            },
+            "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+              { # Contains the details of the execution of this task.
+                "taskAttemptStats": [ # Status for the current task execution attempt.
+                  { # Status for the execution attempt.
+                    "endTime": "A String", # The end time of the event execution for current attempt.
+                    "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+                  },
+                ],
+                "taskExecutionState": "A String", # The execution state of this task.
+                "taskNumber": "A String", # Pointer to the task config it used for execution.
+              },
+            ],
+          },
+        ],
+        "state": "A String", # Status of the execution.
+      },
+      "executionMethod": "A String", # The ways user posts this event.
+      "name": "A String", # Auto-generated primary key.
+      "requestParameters": { # Event parameters come in as part of the request.
+        "a_key": { # The type of the parameter.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+      },
+      "requestParams": [ # Event parameters come in as part of the request.
+        { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      ],
+      "responseParameters": { # Event parameters returned as part of the response.
+        "a_key": { # The type of the parameter.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+      },
+      "responseParams": [ # Event parameters come out as part of the response.
+        { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      ],
+      "triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+      "updateTime": "A String", # Output only. Last modified time of the execution.
+    },
+  ],
+  "nextPageToken": "A String", # The token used to retrieve the next page 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/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html new file mode 100644 index 00000000000..01ec8350e9d --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executions.suspensions.html @@ -0,0 +1,441 @@ + + + +

Application Integration API . projects . locations . products . integrations . executions . suspensions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

* Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ lift(name, body=None, x__xgafv=None) +
* Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
+
+Args:
+  name: string, Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for lift Suspension
+  "suspensionResult": "A String", # User passed in suspension result and will be used to control workflow execution branching behavior by setting up corresponnding edge condition with suspension result. For example, if you want to lift the suspension, you can pass "Approved", or if you want to reject the suspension and terminate workfloe execution, you can pass "Rejected" and terminate the workflow execution with configuring the edge condition.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of lift Suspense
+  "eventExecutionInfoId": "A String", # Execution Id that will be returned
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
+
+Args:
+  parent: string, Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name} (required)
+  filter: string, Standard filter field.
+  orderBy: string, Field name to order by.
+  pageSize: integer, Maximum number of entries in the response.
+  pageToken: string, Token to retrieve a specific page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for Suspensions.ListSuspensions.
+  "nextPageToken": "A String", # Token to retrieve the next page of results.
+  "suspensions": [ # The suspensions for the relevant execution which the caller has permissions to view and resolve.
+    { # A record representing a suspension.
+      "approvalConfig": { # Configurations for approving the Suspension. # Controls the notifications and approval permissions for this suspension.
+        "customMessage": "A String", # Information to provide for recipients.
+        "emailAddresses": [ # Email addresses to send approval request to.
+          "A String",
+        ],
+        "expiration": { # Expiration configs for the approval request. # Indicates the next steps when no external actions happen on the suspension.
+          "expireTime": "A String", # Output only. Time after which the suspension expires, if no action taken.
+          "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+          "remindTime": "A String", # Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+        },
+      },
+      "audit": { # Contains when and by whom the suspension was resolved. # Metadata pertaining to the resolution of this suspension.
+        "resolveTime": "A String", # Time at which this suspension was resolved.
+        "resolver": "A String", # Email address of the person who resolved this suspension.
+      },
+      "createTime": "A String", # Output only. Auto-generated.
+      "eventExecutionInfoId": "A String", # Required. ID of the associated execution.
+      "integration": "A String", # Required. The name of the originating integration.
+      "lastModifyTime": "A String", # Output only. Auto-generated.
+      "name": "A String", # Resource name for suspensions suspension/{suspension_id}
+      "state": "A String", # Required. State of this suspension, indicating what action a resolver has taken.
+      "suspensionConfig": { # Controls the notifications and resolver permissions for this suspension.
+        "customMessage": "A String", # Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.
+        "notifications": [
+          {
+            "buganizerNotification": {
+              "assigneeEmailAddress": "A String", # Whom to assign the new bug. Optional.
+              "componentId": "A String", # ID of the buganizer component within which to create a new issue. Required.
+              "templateId": "A String", # ID of the buganizer template to use. Optional.
+              "title": "A String", # Title of the issue to be created. Required.
+            },
+            "emailAddress": { # Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
+              "email": "A String", # Required.
+              "name": "A String",
+              "tokens": [
+                {
+                  "name": "A String",
+                  "value": "A String",
+                },
+              ],
+            },
+            "escalatorQueue": "A String",
+            "pubsubTopic": "A String",
+            "request": { # If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
+              "postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message.
+                "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.
+                "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.
+                "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional.
+                  "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                    { # Key-value pair of EventBus parameters.
+                      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                      "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                        "booleanArray": {
+                          "booleanValues": [
+                            True or False,
+                          ],
+                        },
+                        "booleanValue": True or False,
+                        "doubleArray": {
+                          "doubleValues": [
+                            3.14,
+                          ],
+                        },
+                        "doubleValue": 3.14,
+                        "intArray": {
+                          "intValues": [
+                            "A String",
+                          ],
+                        },
+                        "intValue": "A String",
+                        "protoArray": {
+                          "protoValues": [
+                            {
+                              "a_key": "", # Properties of the object. Contains field @type with type URL.
+                            },
+                          ],
+                        },
+                        "protoValue": {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                        "serializedObjectValue": {
+                          "objectValue": "A String",
+                        },
+                        "stringArray": {
+                          "stringValues": [
+                            "A String",
+                          ],
+                        },
+                        "stringValue": "A String",
+                      },
+                    },
+                  ],
+                },
+                "priority": "A String", # The request priority this request should be processed at. For internal users:
+                "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
+                "scheduledTime": "A String", # Optional. Time in milliseconds since epoch when the given event would be scheduled.
+                "testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.
+                "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.
+                "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.
+              },
+              "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key.
+            },
+          },
+        ],
+        "suspensionExpiration": { # Indicates the next steps when no external actions happen on the suspension.
+          "expireAfterMs": 42, # Milliseconds after which the suspension expires, if no action taken.
+          "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+          "remindAfterMs": 42, # Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+        },
+        "whoMayResolve": [ # Identities able to resolve this suspension.
+          { # LINT.IfChange
+            "gaiaIdentity": { # Represents a Gaia identity for a person or service account.
+              "emailAddress": "A String",
+              "gaiaId": "A String",
+            },
+            "googleGroup": {
+              "emailAddress": "A String",
+              "gaiaId": "A String",
+            },
+            "loasRole": "A String",
+            "mdbGroup": "A String",
+          },
+        ],
+      },
+      "taskId": "A String", # Required. Task id of the associated SuspensionTask.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ resolve(name, body=None, x__xgafv=None) +
* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
+
+Args:
+  name: string, Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for [Suspensions.ResolveSuspensions].
+  "suspension": { # A record representing a suspension. # Suspension, containing the event_execution_info_id, task_id, and state to set on the corresponding suspension record.
+    "approvalConfig": { # Configurations for approving the Suspension. # Controls the notifications and approval permissions for this suspension.
+      "customMessage": "A String", # Information to provide for recipients.
+      "emailAddresses": [ # Email addresses to send approval request to.
+        "A String",
+      ],
+      "expiration": { # Expiration configs for the approval request. # Indicates the next steps when no external actions happen on the suspension.
+        "expireTime": "A String", # Output only. Time after which the suspension expires, if no action taken.
+        "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+        "remindTime": "A String", # Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+      },
+    },
+    "audit": { # Contains when and by whom the suspension was resolved. # Metadata pertaining to the resolution of this suspension.
+      "resolveTime": "A String", # Time at which this suspension was resolved.
+      "resolver": "A String", # Email address of the person who resolved this suspension.
+    },
+    "createTime": "A String", # Output only. Auto-generated.
+    "eventExecutionInfoId": "A String", # Required. ID of the associated execution.
+    "integration": "A String", # Required. The name of the originating integration.
+    "lastModifyTime": "A String", # Output only. Auto-generated.
+    "name": "A String", # Resource name for suspensions suspension/{suspension_id}
+    "state": "A String", # Required. State of this suspension, indicating what action a resolver has taken.
+    "suspensionConfig": { # Controls the notifications and resolver permissions for this suspension.
+      "customMessage": "A String", # Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.
+      "notifications": [
+        {
+          "buganizerNotification": {
+            "assigneeEmailAddress": "A String", # Whom to assign the new bug. Optional.
+            "componentId": "A String", # ID of the buganizer component within which to create a new issue. Required.
+            "templateId": "A String", # ID of the buganizer template to use. Optional.
+            "title": "A String", # Title of the issue to be created. Required.
+          },
+          "emailAddress": { # Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
+            "email": "A String", # Required.
+            "name": "A String",
+            "tokens": [
+              {
+                "name": "A String",
+                "value": "A String",
+              },
+            ],
+          },
+          "escalatorQueue": "A String",
+          "pubsubTopic": "A String",
+          "request": { # If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
+            "postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message.
+              "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.
+              "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.
+              "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional.
+                "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                  { # Key-value pair of EventBus parameters.
+                    "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                    "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                      "booleanArray": {
+                        "booleanValues": [
+                          True or False,
+                        ],
+                      },
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "doubleValues": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "intValues": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoArray": {
+                        "protoValues": [
+                          {
+                            "a_key": "", # Properties of the object. Contains field @type with type URL.
+                          },
+                        ],
+                      },
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "serializedObjectValue": {
+                        "objectValue": "A String",
+                      },
+                      "stringArray": {
+                        "stringValues": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+              "priority": "A String", # The request priority this request should be processed at. For internal users:
+              "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
+              "scheduledTime": "A String", # Optional. Time in milliseconds since epoch when the given event would be scheduled.
+              "testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.
+              "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.
+              "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.
+            },
+            "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key.
+          },
+        },
+      ],
+      "suspensionExpiration": { # Indicates the next steps when no external actions happen on the suspension.
+        "expireAfterMs": 42, # Milliseconds after which the suspension expires, if no action taken.
+        "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+        "remindAfterMs": 42, # Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+      },
+      "whoMayResolve": [ # Identities able to resolve this suspension.
+        { # LINT.IfChange
+          "gaiaIdentity": { # Represents a Gaia identity for a person or service account.
+            "emailAddress": "A String",
+            "gaiaId": "A String",
+          },
+          "googleGroup": {
+            "emailAddress": "A String",
+            "gaiaId": "A String",
+          },
+          "loasRole": "A String",
+          "mdbGroup": "A String",
+        },
+      ],
+    },
+    "taskId": "A String", # Required. Task id of the associated SuspensionTask.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for Suspensions.ResolveSuspensions.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executionsnapshots.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executionsnapshots.html new file mode 100644 index 00000000000..08010aee902 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.executionsnapshots.html @@ -0,0 +1,256 @@ + + + +

Application Integration API . projects . locations . products . integrations . executionsnapshots

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

Lists the snapshots of a given integration executions. This RPC is not being used.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists the snapshots of a given integration executions. This RPC is not being used.
+
+Args:
+  parent: string, Required. The parent resource name of the integration execution. (required)
+  filter: string, Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
+  pageSize: integer, Number of entries to be returned in a page.
+  pageToken: string, The token used to retrieve the next page results.
+  readMask: string, View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for listing the integration execution snapshot.
+  "executionSnapshots": [ # Required. The detailed information for the execution snapshot.
+    { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+      "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+      "conditionResults": [ # All of the computed conditions that been calculated.
+        { # Contains the combined condition calculation results.
+          "currentTaskNumber": "A String", # the current task number.
+          "nextTaskNumber": "A String", # the next task number.
+          "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+        },
+      ],
+      "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+        "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+          { # Key-value pair of EventBus parameters.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        ],
+      },
+      "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+      "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+      "eventExecutionSnapshotMetadata": {
+        "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+        "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+        "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+        "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+      },
+      "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+        "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+          { # Key-value pair of EventBus parameters.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        ],
+      },
+      "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+      "snapshotTime": "A String", # Indicates when this snapshot is taken.
+      "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+        { # Contains the details of the execution of this task. Next available id: 11
+          "taskAttemptStats": [
+            {
+              "endTime": "A String", # The end time of the task execution for current attempt.
+              "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+            },
+          ],
+          "taskExecutionState": "A String",
+          "taskNumber": "A String", # Pointer to the task config it used for execution.
+        },
+      ],
+      "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+    },
+  ],
+  "nextPageToken": "A String", # The token returned in the previous response.
+}
+
+ +
+ 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/integrations_v1alpha.projects.locations.products.integrations.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html new file mode 100644 index 00000000000..7d3b99d4f66 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html @@ -0,0 +1,710 @@ + + + +

Application Integration API . projects . locations . products . integrations

+

Instance Methods

+

+ executions() +

+

Returns the executions Resource.

+ +

+ executionsnapshots() +

+

Returns the executionsnapshots Resource.

+ +

+ versions() +

+

Returns the versions Resource.

+ +

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

+

PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.

+

+ close()

+

Close httplib2 connections.

+

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

+

Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns the list of all integrations in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

+ monitorexecutionstats(parent, body=None, x__xgafv=None)

+

Get execution stats

+

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

+

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

+

Method Details

+
+ archiveBundle(name, body=None, x__xgafv=None) +
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
+
+Args:
+  name: string, Required. The bundle to archive. Format: projects/{project}/integrations/{integration} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for ArchiveBundle.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ArchiveBundle.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ execute(name, body=None, x__xgafv=None) +
Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
+
+Args:
+  name: string, Required. The integration resource name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for executing an integration.
+  "doNotPropagateError": True or False, # Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.
+  "executionId": "A String", # Optional. The id of the ON_HOLD execution to be resumed.
+  "inputParameters": { # Optional. Input parameters used by integration execution.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+  "parameterEntries": [ # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+  "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution. Redacted
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+      { # Key-value pair of EventBus parameters.
+        "dataType": "A String", # Explicitly getting the type of the parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+  "triggerId": "A String", # Optional. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for executing an integration.
+  "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed.
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+      { # Key-value pair of EventBus parameters.
+        "dataType": "A String", # Explicitly getting the type of the parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
+  "executionId": "A String", # The id of the execution corresponding to this run of integration.
+  "outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
+    "a_key": "", # Properties of the object.
+  },
+  "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all integrations in the specified project.
+
+Args:
+  parent: string, Required. Project and location from which the integrations should be listed. Format: projects/{project} (required)
+  filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+  orderBy: string, The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
+  pageSize: integer, The page size for the resquest.
+  pageToken: string, The page token for the resquest.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListIntegrations.
+  "integrations": [ # The integrations which match the request.
+    { # The integration definition.
+      "active": True or False, # Required. If any integration version is published.
+      "description": "A String", # Optional.
+      "name": "A String", # Required. The resource name of the integration.
+      "updateTime": "A String", # Output only. Auto-generated.
+    },
+  ],
+  "nextPageToken": "A String", # The next page token for the response.
+}
+
+ +
+ 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.
+        
+
+ +
+ monitorexecutionstats(parent, body=None, x__xgafv=None) +
Get execution stats
+
+Args:
+  parent: string, Required. The parent resource name: {parent=projects/*/locations/*}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to get data for monarch connector config.
+  "duration": "A String", # How long the series data range: "1h","1d",etc.
+  "endTime": "A String", # Final time to query over, or the current time if left unset.
+  "mashQuery": { # The MashQuery for searching data, set both queries for Join Operation. # Required. Query for searching data in monarch.
+    "firstQuery": { # The components for constructing MashQuery. # Required. The components for constructing a mash query. Set "point_operation" if this is a single query
+      "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+      "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+        "A String",
+      ],
+      "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+        "A String",
+      ],
+      "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+        "fields": [ # Optional. optional, metrics list for GroupBy.
+          "A String",
+        ],
+        "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+      },
+      "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+      "timeDelta": "A String", # Required. Window time delta.
+    },
+    "operationMode": { # Operation between 2 query # Optional. optional, only set when joining 2 queries. By default join 2 queries with join operation.
+      "joinConfig": { # Join Operation # Optional. join operation
+      },
+      "operationType": "A String", # Optional. optional operation types.
+      "unionConfig": { # Union operation # Optional. union operation
+        "reducer": "A String", # Optional. optional, reduce function
+      },
+    },
+    "secondQuery": { # The components for constructing MashQuery. # Optional. optional, only set when joining 2 queries. Set "point_operation" for joined query.
+      "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+      "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+        "A String",
+      ],
+      "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+        "A String",
+      ],
+      "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+        "fields": [ # Optional. optional, metrics list for GroupBy.
+          "A String",
+        ],
+        "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+      },
+      "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+      "timeDelta": "A String", # Required. Window time delta.
+    },
+  },
+  "metricFieldTable": True or False, # Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality.
+  "outputPeriod": "A String", # The output period for the query. Must be set if there is a window operation within the query and unset otherwise.
+  "responseTemplate": "A String", # Required. Template for response.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for getting Execution stats.
+  "aplosSeriesListData": { # Data used for Aplos charts that accept multiple Series. # List of points.
+    "series": [
+      {
+        "data": { # Data used to render an Aplos Series card.
+          "rows": [ # A single Series Row
+            { # Aplos series row is exactly two columns labeled x and y.
+              "x": {
+                "booleanValue": True or False,
+                "doubleValue": 3.14,
+                "empty": { # 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); }
+                },
+                "longValue": "A String",
+                "stringValue": "A String",
+              },
+              "y": {
+                "booleanValue": True or False,
+                "doubleValue": 3.14,
+                "empty": { # 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); }
+                },
+                "longValue": "A String",
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "name": "A String",
+      },
+    ],
+  },
+  "tableData": { # The generic data format returned from all connectors. # Data in form of table.
+    "headers": [ # Ordered list of column headers.
+      "A String",
+    ],
+    "rows": [ # Ordered list of table rows.
+      {
+        "cells": [ # Ordered list of cell values within a row.
+          {
+            "booleanValue": True or False,
+            "doubleValue": 3.14,
+            "empty": { # 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); }
+            },
+            "longValue": "A String",
+            "stringValue": "A String",
+          },
+        ],
+      },
+    ],
+  },
+}
+
+ +
+ schedule(name, body=None, x__xgafv=None) +
Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
+
+Args:
+  name: string, The integration resource name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for scheduling an integration.
+  "inputParameters": { # Optional. Input parameters used by integration execution.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+  "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+  "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each integration execution.
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+      { # Key-value pair of EventBus parameters.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "requestId": "A String", # This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+  "scheduleTime": "A String", # The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
+  "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for executing an integration.
+  "executionInfoIds": [ # The execution info id for the executed integrations.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html new file mode 100644 index 00000000000..c44480b77d6 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html @@ -0,0 +1,7353 @@ + + + +

Application Integration API . projects . locations . products . integrations . versions

+

Instance Methods

+

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

+

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, newIntegration=None, x__xgafv=None)

+

Create a integration with a draft version in the specified project.

+

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

+

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

+

+ download(name, fileFormat=None, x__xgafv=None)

+

Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.

+

+ get(name, x__xgafv=None)

+

Get a integration in the specified project.

+

+ getBundle(name, x__xgafv=None)

+

PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle

+

+ list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns the list of all integration versions in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a integration with a draft version in the specified project.

+

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

+

This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.

+

+ takeoverEditLock(integrationVersion, body=None, x__xgafv=None)

+

Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.

+

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

+

THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle

+

+ upload(parent, body=None, x__xgafv=None)

+

Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.

+

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

+

Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.

+

Method Details

+
+ archive(name, body=None, x__xgafv=None) +
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
+
+Args:
+  name: string, Required. The version to archive. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for ArchiveIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ArchiveIntegrationVersion.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, newIntegration=None, x__xgafv=None) +
Create a integration with a draft version in the specified project.
+
+Args:
+  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+  newIntegration: boolean, Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+Args:
+  name: string, Required. The version to deactivate. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DeactivateIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for DeactivateIntegrationVersion.
+}
+
+ +
+ download(name, fileFormat=None, x__xgafv=None) +
Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
+
+Args:
+  name: string, Required. The version to download. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  fileFormat: string, File format for download request.
+    Allowed values
+      FILE_FORMAT_UNSPECIFIED - Unspecified file format
+      JSON - JSON File Format
+      YAML - YAML File Format
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for DownloadIntegrationVersion.
+  "content": "A String", # String representation of the integration version.
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a integration in the specified project.
+
+Args:
+  name: string, Required. The version to retrieve. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ getBundle(name, x__xgafv=None) +
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
+
+Args:
+  name: string, Required. The bundle name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for GetBundle.
+  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the bundle data
+    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+      "A String",
+    ],
+    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+  },
+}
+
+ +
+ list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all integration versions in the specified project.
+
+Args:
+  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client". (required)
+  fieldMask: string, The field mask which specifies the particular data to be returned.
+  filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+  orderBy: string, The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".
+  pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` 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 for ListIntegrationVersions.
+  "integrationVersions": [ # The integrations which match the request.
+    { # The integration version definition.
+      "createTime": "A String", # Output only. Auto-generated.
+      "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+      "description": "A String", # Optional. The integration description.
+      "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+        { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+          "dataType": "A String", # Type of the parameter.
+          "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+          "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter.
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "searchable": True or False, # Searchable in the execution log or not.
+        },
+      ],
+      "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+        "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+          {
+            "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+              "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+              "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+              "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+              "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+                "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+                "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+                  "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+                  "logType": [ # To which type(s) of logs the sanitize options apply.
+                    "A String",
+                  ],
+                  "privacy": "A String",
+                  "sanitizeType": "A String",
+                },
+                "seedPeriod": "A String",
+                "seedScope": "A String",
+                "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+                  "logAction": "A String",
+                  "logType": [ # To which type(s) of logs the limits apply.
+                    "A String",
+                  ],
+                  "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+                  "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+                  "shortenerType": "A String",
+                },
+              },
+              "searchable": "A String",
+              "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+                "A String",
+              ],
+            },
+            "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+              # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+            ],
+            "dataType": "A String", # The data type of the parameter.
+            "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "inOutType": "A String", # Specifies the input/output type for the parameter.
+            "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+            "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+            "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+              "elementIdentifier": "A String", # Configuration of the edge.
+              "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+            },
+            "producer": "A String",
+            "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+            "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+          },
+        ],
+      },
+      "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "name": "A String", # Output only. Auto-generated primary key.
+      "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+      "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+      "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+      "state": "A String", # Output only. User should not set it as an input.
+      "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+      "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+        { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+          "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+            "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+            "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+          "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+          "parameters": { # Optional. The customized parameters the user can pass to this task.
+            "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+            },
+          },
+          "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+            "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+          },
+          "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+            "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+            "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "task": "A String", # Optional. The name for the task.
+          "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+          "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+          "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+        },
+      ],
+      "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+        { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+          "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+            { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+              "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+              "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+              "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+              "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+              "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "errorEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+              "metricType": "A String",
+              "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+              "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+              "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+                "absolute": "A String",
+                "percentage": 42,
+              },
+              "warningEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+            },
+          ],
+          "createTime": "A String", # Auto-generated.
+          "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+          "description": "A String", # User-provided description intended to give more business context about the task.
+          "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+          "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+            "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+            "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+          "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+          "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+          "lastModifiedTime": "A String", # Auto-generated.
+          "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+                { # This message recursively combines constituent conditions using logical AND.
+                  "conditions": [ # A set of individual constituent conditions.
+                    { # Condition that uses `operator` to evaluate the key against the value.
+                      "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                      "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                      "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                        "booleanValue": True or False,
+                        "doubleArray": {
+                          "values": [
+                            3.14,
+                          ],
+                        },
+                        "doubleValue": 3.14,
+                        "intArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "intValue": "A String",
+                        "protoValue": {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                        "stringArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "stringValue": "A String",
+                      },
+                    },
+                  ],
+                },
+              ],
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+              "label": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskNumber": "A String", # Task number of the next task.
+            },
+          ],
+          "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+          "parameters": { # The customized parameters the user can pass to this task.
+            "a_key": { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          },
+          "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+            "x": 42,
+            "y": 42,
+          },
+          "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+          "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+          "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+                { # Key-value pair of EventBus parameters.
+                  "dataType": "A String", # Explicitly getting the type of the parameter.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                  "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+            "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+              "A String",
+            ],
+          },
+          "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+            "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+          },
+          "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+            "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+            "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+            "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+            "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+              "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+              "admins": [
+                { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+                  "googleGroupEmail": "A String",
+                  "userEmail": "A String",
+                },
+              ],
+              "category": "A String",
+              "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+              "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+              "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+              "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+              "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+              "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+              "externalCategory": "A String",
+              "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+              "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+              "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+              "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+              "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+              "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+              "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+              "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+              "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+              "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+              "system": "A String",
+              "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+                "A String",
+              ],
+            },
+            "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+              "parameters": [
+                { # Key-value pair of EventBus task parameters. Next id: 13
+                  "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+                  "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+                  "config": { # Optional fields, such as help text and other useful info.
+                    "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                    "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                    "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                    "inputDisplayOption": "A String",
+                    "isHidden": True or False, # Whether this field is hidden in the UI.
+                    "label": "A String", # A user-friendly label for the parameter.
+                    "parameterNameOption": "A String",
+                    "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                    "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+                  },
+                  "dataType": "A String", # The data type of the parameter.
+                  "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                  "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+                  "isOutput": True or False,
+                  "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+                  "protoDef": { # Populated if this represents a proto or proto array.
+                    "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                    "path": "A String", # Path to the proto file that contains the message type's definition.
+                  },
+                  "required": True or False, # If set, the user must provide an input value for this parameter.
+                  "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                    "doubleRange": { # Range used to validate doubles and floats.
+                      "max": 3.14, # The inclusive maximum of the acceptable range.
+                      "min": 3.14, # The inclusive minimum of the acceptable range.
+                    },
+                    "intRange": { # Range used to validate longs and ints.
+                      "max": "A String", # The inclusive maximum of the acceptable range.
+                      "min": "A String", # The inclusive minimum of the acceptable range.
+                    },
+                    "stringRegex": { # Rule used to validate strings.
+                      "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                      "regex": "A String", # The regex applied to the input value(s).
+                    },
+                  },
+                },
+              ],
+            },
+            "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+              "dimensions": { # Dimensions that these stats have been aggregated on.
+                "clientId": "A String",
+                "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+                "errorEnumString": "A String",
+                "retryAttempt": "A String",
+                "taskName": "A String",
+                "taskNumber": "A String",
+                "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+                "warningEnumString": "A String",
+                "workflowId": "A String",
+                "workflowName": "A String",
+              },
+              "durationInSeconds": 3.14, # Average duration in seconds.
+              "errorRate": 3.14, # Average error rate.
+              "qps": 3.14, # Queries per second.
+              "warningRate": 3.14, # Average warning rate.
+            },
+            "taskType": "A String", # Defines the type of the task
+            "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+              "taskUiModuleConfigs": [ # Configurations of included config modules.
+                { # Task author would use this type to configure a config module.
+                  "moduleId": "A String", # ID of the config module.
+                },
+              ],
+            },
+          },
+          "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+          "taskName": "A String", # The name for the task.
+          "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+          "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+          "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+          "taskType": "A String", # Defines the type of the task
+        },
+      ],
+      "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+        "teardownTaskConfigs": [ # Required.
+          {
+            "creatorEmail": "A String", # The creator's email address.
+            "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+            "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+              "name": "A String", # Required. Name of the next teardown task.
+            },
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+              "properties": [ # An unordered list of property entries.
+                { # Key-value pair of EventBus property.
+                  "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+          },
+        ],
+      },
+      "triggerConfigs": [ # Optional. Trigger configurations.
+        { # Configuration detail of a trigger.
+          "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+            { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+              "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+              "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+              "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+              "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "metricType": "A String", # The type of metric.
+              "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+              "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+                "absolute": "A String", # Absolute value threshold.
+                "percentage": 42, # Percentage threshold.
+              },
+            },
+          ],
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "label": "A String", # Optional. The user created label for a particular trigger.
+          "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+          "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+            "a_key": "A String",
+          },
+          "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "triggerId": "A String", # Optional. The backend trigger ID.
+          "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+          "triggerType": "A String", # Optional. Type of trigger
+        },
+      ],
+      "triggerConfigsInternal": [ # Optional. Trigger configurations.
+        { # Configuration detail of a trigger. Next available id: 16
+          "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+            { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+              "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+              "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+              "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+              "clientId": "A String", # Client associated with this alert configuration.
+              "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "errorEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+              "metricType": "A String",
+              "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+              "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+              "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+                "absolute": "A String",
+                "percentage": 42,
+              },
+              "warningEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+            },
+          ],
+          "description": "A String", # User-provided description intended to give more business context about the task.
+          "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+            "A String",
+          ],
+          "label": "A String", # The user created label for a particular trigger.
+          "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+          "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+          "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+            "x": 42,
+            "y": 42,
+          },
+          "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+            "a_key": "A String",
+          },
+          "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+                { # This message recursively combines constituent conditions using logical AND.
+                  "conditions": [ # A set of individual constituent conditions.
+                    { # Condition that uses `operator` to evaluate the key against the value.
+                      "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                      "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                      "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                        "booleanValue": True or False,
+                        "doubleArray": {
+                          "values": [
+                            3.14,
+                          ],
+                        },
+                        "doubleValue": 3.14,
+                        "intArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "intValue": "A String",
+                        "protoValue": {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                        "stringArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "stringValue": "A String",
+                      },
+                    },
+                  ],
+                },
+              ],
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+              "label": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskNumber": "A String", # Task number of the next task.
+            },
+          ],
+          "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+            "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+          },
+          "triggerId": "A String", # The backend trigger ID.
+          "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+          "triggerType": "A String",
+        },
+      ],
+      "updateTime": "A String", # Output only. Auto-generated.
+      "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+    },
+  ],
+  "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.
+  "noPermission": True or False, # Whether the user has no permission on the version or not.
+}
+
+ +
+ 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) +
Update a integration with a draft version in the specified project.
+
+Args:
+  name: string, Output only. Auto-generated primary key. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+  updateMask: string, Field mask specifying the fields in the above integration that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The integration version definition.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The integration description.
+  "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+      "dataType": "A String", # Type of the parameter.
+      "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+        "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+          "booleanValues": [ # Boolean array.
+            True or False,
+          ],
+        },
+        "booleanValue": True or False, # Boolean.
+        "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+          "doubleValues": [ # Double number array.
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14, # Double Number.
+        "intArray": { # This message only contains a field of integer array. # Integer Array.
+          "intValues": [ # Integer array.
+            "A String",
+          ],
+        },
+        "intValue": "A String", # Integer.
+        "jsonValue": "A String", # Json.
+        "stringArray": { # This message only contains a field of string array. # String Array.
+          "stringValues": [ # String array.
+            "A String",
+          ],
+        },
+        "stringValue": "A String", # String.
+      },
+      "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+      "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+      "isTransient": True or False, # Whether this parameter is a transient parameter.
+      "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+      "searchable": True or False, # Searchable in the execution log or not.
+    },
+  ],
+  "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key.
+  "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+  "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+  "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+  "state": "A String", # Output only. User should not set it as an input.
+  "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+        "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+    },
+  ],
+  "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger.
+      "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+          "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+          "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "metricType": "A String", # The type of metric.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String", # Absolute value threshold.
+            "percentage": 42, # Percentage threshold.
+          },
+        },
+      ],
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "label": "A String", # Optional. The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+      "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerId": "A String", # Optional. The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+      "triggerType": "A String", # Optional. Type of trigger
+    },
+  ],
+  "triggerConfigsInternal": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ publish(name, body=None, x__xgafv=None) +
This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
+
+Args:
+  name: string, Required. The version to publish. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for PublishIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for PublishIntegrationVersion.
+}
+
+ +
+ takeoverEditLock(integrationVersion, body=None, x__xgafv=None) +
Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.
+
+Args:
+  integrationVersion: string, Required. The version to take over edit lock. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for TakeoverEditLock.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for TakeoverEditLock.
+  "integrationVersion": { # The integration version definition. # Version after the lock is acquired by the new user.
+    "createTime": "A String", # Output only. Auto-generated.
+    "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+    "description": "A String", # Optional. The integration description.
+    "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+        "dataType": "A String", # Type of the parameter.
+        "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+        "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter.
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+        "searchable": True or False, # Searchable in the execution log or not.
+      },
+    ],
+    "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+        {
+          "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+            "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+            "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+              "booleanValue": True or False,
+              "doubleArray": {
+                "values": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "stringArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+            "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+            "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+              "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+              "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+                "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+                "logType": [ # To which type(s) of logs the sanitize options apply.
+                  "A String",
+                ],
+                "privacy": "A String",
+                "sanitizeType": "A String",
+              },
+              "seedPeriod": "A String",
+              "seedScope": "A String",
+              "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+                "logAction": "A String",
+                "logType": [ # To which type(s) of logs the limits apply.
+                  "A String",
+                ],
+                "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+                "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+                "shortenerType": "A String",
+              },
+            },
+            "searchable": "A String",
+            "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+              "A String",
+            ],
+          },
+          "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+            # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+          ],
+          "dataType": "A String", # The data type of the parameter.
+          "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "inOutType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+            "elementIdentifier": "A String", # Configuration of the edge.
+            "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+          },
+          "producer": "A String",
+          "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+          "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+        },
+      ],
+    },
+    "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "name": "A String", # Output only. Auto-generated primary key.
+    "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+    "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+    "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+    "state": "A String", # Output only. User should not set it as an input.
+    "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+    "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+        "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # Optional. The customized parameters the user can pass to this task.
+          "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "task": "A String", # Optional. The name for the task.
+        "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+        "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+        "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+      },
+    ],
+    "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+        "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+          { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+            "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+            "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "createTime": "A String", # Auto-generated.
+        "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+        "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+        "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+        "lastModifiedTime": "A String", # Auto-generated.
+        "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # The customized parameters the user can pass to this task.
+          "a_key": { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        },
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+        "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+        "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+              { # Key-value pair of EventBus parameters.
+                "dataType": "A String", # Explicitly getting the type of the parameter.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+          "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+            "A String",
+          ],
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+          "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+          "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+            "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+            "admins": [
+              { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+                "googleGroupEmail": "A String",
+                "userEmail": "A String",
+              },
+            ],
+            "category": "A String",
+            "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+            "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+            "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+            "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+            "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+            "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+            "externalCategory": "A String",
+            "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+            "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+            "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+            "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+            "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+            "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+            "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+            "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+            "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+            "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+            "system": "A String",
+            "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+              "A String",
+            ],
+          },
+          "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+            "parameters": [
+              { # Key-value pair of EventBus task parameters. Next id: 13
+                "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+                "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+                "config": { # Optional fields, such as help text and other useful info.
+                  "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                  "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                  "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                  "inputDisplayOption": "A String",
+                  "isHidden": True or False, # Whether this field is hidden in the UI.
+                  "label": "A String", # A user-friendly label for the parameter.
+                  "parameterNameOption": "A String",
+                  "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                  "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+                },
+                "dataType": "A String", # The data type of the parameter.
+                "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+                "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+                "isOutput": True or False,
+                "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+                "protoDef": { # Populated if this represents a proto or proto array.
+                  "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                  "path": "A String", # Path to the proto file that contains the message type's definition.
+                },
+                "required": True or False, # If set, the user must provide an input value for this parameter.
+                "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                  "doubleRange": { # Range used to validate doubles and floats.
+                    "max": 3.14, # The inclusive maximum of the acceptable range.
+                    "min": 3.14, # The inclusive minimum of the acceptable range.
+                  },
+                  "intRange": { # Range used to validate longs and ints.
+                    "max": "A String", # The inclusive maximum of the acceptable range.
+                    "min": "A String", # The inclusive minimum of the acceptable range.
+                  },
+                  "stringRegex": { # Rule used to validate strings.
+                    "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                    "regex": "A String", # The regex applied to the input value(s).
+                  },
+                },
+              },
+            ],
+          },
+          "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+            "dimensions": { # Dimensions that these stats have been aggregated on.
+              "clientId": "A String",
+              "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+              "errorEnumString": "A String",
+              "retryAttempt": "A String",
+              "taskName": "A String",
+              "taskNumber": "A String",
+              "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+              "warningEnumString": "A String",
+              "workflowId": "A String",
+              "workflowName": "A String",
+            },
+            "durationInSeconds": 3.14, # Average duration in seconds.
+            "errorRate": 3.14, # Average error rate.
+            "qps": 3.14, # Queries per second.
+            "warningRate": 3.14, # Average warning rate.
+          },
+          "taskType": "A String", # Defines the type of the task
+          "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+            "taskUiModuleConfigs": [ # Configurations of included config modules.
+              { # Task author would use this type to configure a config module.
+                "moduleId": "A String", # ID of the config module.
+              },
+            ],
+          },
+        },
+        "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+        "taskName": "A String", # The name for the task.
+        "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+        "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+        "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+        "taskType": "A String", # Defines the type of the task
+      },
+    ],
+    "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+      "teardownTaskConfigs": [ # Required.
+        {
+          "creatorEmail": "A String", # The creator's email address.
+          "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+          "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+            "name": "A String", # Required. Name of the next teardown task.
+          },
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+            "properties": [ # An unordered list of property entries.
+              { # Key-value pair of EventBus property.
+                "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+                "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "values": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "stringArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+        },
+      ],
+    },
+    "triggerConfigs": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger.
+        "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+            "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+            "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "metricType": "A String", # The type of metric.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String", # Absolute value threshold.
+              "percentage": 42, # Percentage threshold.
+            },
+          },
+        ],
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "label": "A String", # Optional. The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+        "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "triggerId": "A String", # Optional. The backend trigger ID.
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+        "triggerType": "A String", # Optional. Type of trigger
+      },
+    ],
+    "triggerConfigsInternal": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger. Next available id: 16
+        "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+            "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+            "clientId": "A String", # Client associated with this alert configuration.
+            "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+          "A String",
+        ],
+        "label": "A String", # The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+        "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+          "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+        },
+        "triggerId": "A String", # The backend trigger ID.
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+        "triggerType": "A String",
+      },
+    ],
+    "updateTime": "A String", # Output only. Auto-generated.
+    "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+  },
+}
+
+ +
+ updateBundle(name, body=None, x__xgafv=None) +
THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
+
+Args:
+  name: string, Required. Bundle name (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request message for Bundle update
+  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the updated bundle data
+    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+      "A String",
+    ],
+    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+  },
+}
+
+  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 Bundle update
+  "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # Contains updated bundle config
+    "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+      "A String",
+    ],
+    "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+  },
+}
+
+ +
+ upload(parent, body=None, x__xgafv=None) +
Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
+
+Args:
+  parent: string, Required. The version to upload. Format: projects/{project}/integrations/{integration} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for UploadIntegrationVersion.
+  "content": "A String", # The textproto of the integration_version.
+  "fileFormat": "A String", # File format for upload request.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for UploadIntegrationVersion.
+  "integrationVersion": { # The integration version definition. # The uploaded integration.
+    "createTime": "A String", # Output only. Auto-generated.
+    "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+    "description": "A String", # Optional. The integration description.
+    "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+        "dataType": "A String", # Type of the parameter.
+        "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+        "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter.
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+        "searchable": True or False, # Searchable in the execution log or not.
+      },
+    ],
+    "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+        {
+          "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+            "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+            "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+              "booleanValue": True or False,
+              "doubleArray": {
+                "values": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "stringArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+            "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+            "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+              "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+              "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+                "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+                "logType": [ # To which type(s) of logs the sanitize options apply.
+                  "A String",
+                ],
+                "privacy": "A String",
+                "sanitizeType": "A String",
+              },
+              "seedPeriod": "A String",
+              "seedScope": "A String",
+              "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+                "logAction": "A String",
+                "logType": [ # To which type(s) of logs the limits apply.
+                  "A String",
+                ],
+                "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+                "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+                "shortenerType": "A String",
+              },
+            },
+            "searchable": "A String",
+            "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+              "A String",
+            ],
+          },
+          "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+            # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+          ],
+          "dataType": "A String", # The data type of the parameter.
+          "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "inOutType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+            "elementIdentifier": "A String", # Configuration of the edge.
+            "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+          },
+          "producer": "A String",
+          "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+          "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+        },
+      ],
+    },
+    "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "name": "A String", # Output only. Auto-generated primary key.
+    "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+    "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+    "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+    "state": "A String", # Output only. User should not set it as an input.
+    "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+    "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+        "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # Optional. The customized parameters the user can pass to this task.
+          "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "task": "A String", # Optional. The name for the task.
+        "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+        "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+        "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+      },
+    ],
+    "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+        "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+          { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+            "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+            "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "createTime": "A String", # Auto-generated.
+        "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+        "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+        "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+        "lastModifiedTime": "A String", # Auto-generated.
+        "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # The customized parameters the user can pass to this task.
+          "a_key": { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        },
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+        "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+        "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+              { # Key-value pair of EventBus parameters.
+                "dataType": "A String", # Explicitly getting the type of the parameter.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+          "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+            "A String",
+          ],
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+          "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+          "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+            "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+            "admins": [
+              { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+                "googleGroupEmail": "A String",
+                "userEmail": "A String",
+              },
+            ],
+            "category": "A String",
+            "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+            "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+            "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+            "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+            "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+            "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+            "externalCategory": "A String",
+            "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+            "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+            "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+            "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+            "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+            "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+            "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+            "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+            "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+            "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+            "system": "A String",
+            "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+              "A String",
+            ],
+          },
+          "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+            "parameters": [
+              { # Key-value pair of EventBus task parameters. Next id: 13
+                "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+                "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+                "config": { # Optional fields, such as help text and other useful info.
+                  "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                  "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                  "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                  "inputDisplayOption": "A String",
+                  "isHidden": True or False, # Whether this field is hidden in the UI.
+                  "label": "A String", # A user-friendly label for the parameter.
+                  "parameterNameOption": "A String",
+                  "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                  "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+                },
+                "dataType": "A String", # The data type of the parameter.
+                "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+                "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+                "isOutput": True or False,
+                "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+                "protoDef": { # Populated if this represents a proto or proto array.
+                  "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                  "path": "A String", # Path to the proto file that contains the message type's definition.
+                },
+                "required": True or False, # If set, the user must provide an input value for this parameter.
+                "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                  "doubleRange": { # Range used to validate doubles and floats.
+                    "max": 3.14, # The inclusive maximum of the acceptable range.
+                    "min": 3.14, # The inclusive minimum of the acceptable range.
+                  },
+                  "intRange": { # Range used to validate longs and ints.
+                    "max": "A String", # The inclusive maximum of the acceptable range.
+                    "min": "A String", # The inclusive minimum of the acceptable range.
+                  },
+                  "stringRegex": { # Rule used to validate strings.
+                    "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                    "regex": "A String", # The regex applied to the input value(s).
+                  },
+                },
+              },
+            ],
+          },
+          "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+            "dimensions": { # Dimensions that these stats have been aggregated on.
+              "clientId": "A String",
+              "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+              "errorEnumString": "A String",
+              "retryAttempt": "A String",
+              "taskName": "A String",
+              "taskNumber": "A String",
+              "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+              "warningEnumString": "A String",
+              "workflowId": "A String",
+              "workflowName": "A String",
+            },
+            "durationInSeconds": 3.14, # Average duration in seconds.
+            "errorRate": 3.14, # Average error rate.
+            "qps": 3.14, # Queries per second.
+            "warningRate": 3.14, # Average warning rate.
+          },
+          "taskType": "A String", # Defines the type of the task
+          "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+            "taskUiModuleConfigs": [ # Configurations of included config modules.
+              { # Task author would use this type to configure a config module.
+                "moduleId": "A String", # ID of the config module.
+              },
+            ],
+          },
+        },
+        "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+        "taskName": "A String", # The name for the task.
+        "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+        "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+        "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+        "taskType": "A String", # Defines the type of the task
+      },
+    ],
+    "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+      "teardownTaskConfigs": [ # Required.
+        {
+          "creatorEmail": "A String", # The creator's email address.
+          "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+          "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+            "name": "A String", # Required. Name of the next teardown task.
+          },
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+            "properties": [ # An unordered list of property entries.
+              { # Key-value pair of EventBus property.
+                "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+                "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "values": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "stringArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+        },
+      ],
+    },
+    "triggerConfigs": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger.
+        "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+            "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+            "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "metricType": "A String", # The type of metric.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String", # Absolute value threshold.
+              "percentage": 42, # Percentage threshold.
+            },
+          },
+        ],
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "label": "A String", # Optional. The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+        "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "triggerId": "A String", # Optional. The backend trigger ID.
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+        "triggerType": "A String", # Optional. Type of trigger
+      },
+    ],
+    "triggerConfigsInternal": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger. Next available id: 16
+        "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+            "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+            "clientId": "A String", # Client associated with this alert configuration.
+            "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+          "A String",
+        ],
+        "label": "A String", # The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+        "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+          "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+        },
+        "triggerId": "A String", # The backend trigger ID.
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+        "triggerType": "A String",
+      },
+    ],
+    "updateTime": "A String", # Output only. Auto-generated.
+    "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+  },
+}
+
+ +
+ validate(name, body=None, x__xgafv=None) +
Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
+
+Args:
+  name: string, Required. The version to validate. Format: projects/{project}/integrations/{integration}/versions/{version} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for ValidateIntegrationVersion.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ValidateIntegrationVersion.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.html new file mode 100644 index 00000000000..d4c2d6bdd58 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.html @@ -0,0 +1,91 @@ + + + +

Application Integration API . projects . locations . products . integrationtemplates

+

Instance Methods

+

+ versions() +

+

Returns the versions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html new file mode 100644 index 00000000000..898387ea73f --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html @@ -0,0 +1,3036 @@ + + + +

Application Integration API . projects . locations . products . integrationtemplates . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an IntegrationTemplateVersion.

+

+ get(name, x__xgafv=None)

+

Returns an IntegrationTemplateVersion in the specified project.

+

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

+

Returns the list of all IntegrationTemplateVersions in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an IntegrationTemplateVersion.
+
+Args:
+  parent: string, Required. The parent resource where this TemplateVersion will be created. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # IntegrationTemplateVersion definition. An IntegrationTemplateVersion provides configurations required to construct an IntegrationVersion. It cannot be executed directly like an Integration. Users can create IntegrationTemplateVersions using Integrations. These Templates can be shared by users across GCP projects.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The templateversion description. Permitted format is alphanumeric with underscores and no spaces.
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}
+  "parentIntegrationVersionId": "A String", # Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion
+  "snapshotNumber": "A String", # Output only. An increasing sequence that is set when a new snapshot is created.
+  "status": "A String", # Optional. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # IntegrationTemplateVersion definition. An IntegrationTemplateVersion provides configurations required to construct an IntegrationVersion. It cannot be executed directly like an Integration. Users can create IntegrationTemplateVersions using Integrations. These Templates can be shared by users across GCP projects.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The templateversion description. Permitted format is alphanumeric with underscores and no spaces.
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}
+  "parentIntegrationVersionId": "A String", # Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion
+  "snapshotNumber": "A String", # Output only. An increasing sequence that is set when a new snapshot is created.
+  "status": "A String", # Optional. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns an IntegrationTemplateVersion in the specified project.
+
+Args:
+  name: string, Required. The TemplateVersion to retrieve. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # IntegrationTemplateVersion definition. An IntegrationTemplateVersion provides configurations required to construct an IntegrationVersion. It cannot be executed directly like an Integration. Users can create IntegrationTemplateVersions using Integrations. These Templates can be shared by users across GCP projects.
+  "createTime": "A String", # Output only. Auto-generated.
+  "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+  "description": "A String", # Optional. The templateversion description. Permitted format is alphanumeric with underscores and no spaces.
+  "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+  "name": "A String", # Output only. Auto-generated primary key. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}
+  "parentIntegrationVersionId": "A String", # Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion
+  "snapshotNumber": "A String", # Output only. An increasing sequence that is set when a new snapshot is created.
+  "status": "A String", # Optional. Generated by eventbus. User should not set it as an input.
+  "taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+      "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+        { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+          "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+          "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "createTime": "A String", # Auto-generated.
+      "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+      "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+      "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+      "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+      "lastModifiedTime": "A String", # Auto-generated.
+      "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+      "parameters": { # The customized parameters the user can pass to this task.
+        "a_key": { # Key-value pair of EventBus parameters.
+          "dataType": "A String", # Explicitly getting the type of the parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+        },
+      },
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+      "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+      "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+            { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+        "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+          "A String",
+        ],
+      },
+      "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+        "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+      },
+      "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+        "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+        "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+        "retryStrategy": "A String", # Defines what happens to the task upon failure.
+      },
+      "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+        "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+        "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+          "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+          "admins": [
+            { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+              "googleGroupEmail": "A String",
+              "userEmail": "A String",
+            },
+          ],
+          "category": "A String",
+          "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+          "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+          "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+          "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+          "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+          "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+          "externalCategory": "A String",
+          "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+          "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+          "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+          "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+          "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+          "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+          "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+          "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+          "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+          "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+          "system": "A String",
+          "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+            "A String",
+          ],
+        },
+        "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+          "parameters": [
+            { # Key-value pair of EventBus task parameters. Next id: 13
+              "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+              "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+              "config": { # Optional fields, such as help text and other useful info.
+                "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                "inputDisplayOption": "A String",
+                "isHidden": True or False, # Whether this field is hidden in the UI.
+                "label": "A String", # A user-friendly label for the parameter.
+                "parameterNameOption": "A String",
+                "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+              },
+              "dataType": "A String", # The data type of the parameter.
+              "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+              "isOutput": True or False,
+              "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+              "protoDef": { # Populated if this represents a proto or proto array.
+                "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                "path": "A String", # Path to the proto file that contains the message type's definition.
+              },
+              "required": True or False, # If set, the user must provide an input value for this parameter.
+              "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                "doubleRange": { # Range used to validate doubles and floats.
+                  "max": 3.14, # The inclusive maximum of the acceptable range.
+                  "min": 3.14, # The inclusive minimum of the acceptable range.
+                },
+                "intRange": { # Range used to validate longs and ints.
+                  "max": "A String", # The inclusive maximum of the acceptable range.
+                  "min": "A String", # The inclusive minimum of the acceptable range.
+                },
+                "stringRegex": { # Rule used to validate strings.
+                  "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                  "regex": "A String", # The regex applied to the input value(s).
+                },
+              },
+            },
+          ],
+        },
+        "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+          "dimensions": { # Dimensions that these stats have been aggregated on.
+            "clientId": "A String",
+            "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+            "errorEnumString": "A String",
+            "retryAttempt": "A String",
+            "taskName": "A String",
+            "taskNumber": "A String",
+            "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+            "warningEnumString": "A String",
+            "workflowId": "A String",
+            "workflowName": "A String",
+          },
+          "durationInSeconds": 3.14, # Average duration in seconds.
+          "errorRate": 3.14, # Average error rate.
+          "qps": 3.14, # Queries per second.
+          "warningRate": 3.14, # Average warning rate.
+        },
+        "taskType": "A String", # Defines the type of the task
+        "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+          "taskUiModuleConfigs": [ # Configurations of included config modules.
+            { # Task author would use this type to configure a config module.
+              "moduleId": "A String", # ID of the config module.
+            },
+          ],
+        },
+      },
+      "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+      "taskName": "A String", # The name for the task.
+      "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+      "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+      "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+      "taskType": "A String", # Defines the type of the task
+    },
+  ],
+  "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+    "teardownTaskConfigs": [ # Required.
+      {
+        "creatorEmail": "A String", # The creator's email address.
+        "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+        "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+          "name": "A String", # Required. Name of the next teardown task.
+        },
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+          "properties": [ # An unordered list of property entries.
+            { # Key-value pair of EventBus property.
+              "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+              "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+      },
+    ],
+  },
+  "templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+    "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+      {
+        "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+          "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+          "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+            "booleanValue": True or False,
+            "doubleArray": {
+              "values": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "stringArray": {
+              "values": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+          "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+          "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+            "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+            "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+              "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+              "logType": [ # To which type(s) of logs the sanitize options apply.
+                "A String",
+              ],
+              "privacy": "A String",
+              "sanitizeType": "A String",
+            },
+            "seedPeriod": "A String",
+            "seedScope": "A String",
+            "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+              "logAction": "A String",
+              "logType": [ # To which type(s) of logs the limits apply.
+                "A String",
+              ],
+              "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+              "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+              "shortenerType": "A String",
+            },
+          },
+          "searchable": "A String",
+          "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+            "A String",
+          ],
+        },
+        "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+          # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+        ],
+        "dataType": "A String", # The data type of the parameter.
+        "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+        "inOutType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "elementIdentifier": "A String", # Configuration of the edge.
+          "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+        },
+        "producer": "A String",
+        "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+        "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+      },
+    ],
+  },
+  "triggerConfigs": [ # Optional. Trigger configurations.
+    { # Configuration detail of a trigger. Next available id: 16
+      "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+        { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+          "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+          "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+          "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+          "clientId": "A String", # Client associated with this alert configuration.
+          "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+          "errorEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+          "metricType": "A String",
+          "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+          "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+          "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+          "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+          "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+            "absolute": "A String",
+            "percentage": 42,
+          },
+          "warningEnumList": { # List of error enums for alerts.
+            "enumStrings": [
+              "A String",
+            ],
+            "filterType": "A String",
+          },
+        },
+      ],
+      "description": "A String", # User-provided description intended to give more business context about the task.
+      "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+        "A String",
+      ],
+      "label": "A String", # The user created label for a particular trigger.
+      "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+      "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+      "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+        "x": 42,
+        "y": 42,
+      },
+      "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+        "a_key": "A String",
+      },
+      "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+            { # This message recursively combines constituent conditions using logical AND.
+              "conditions": [ # A set of individual constituent conditions.
+                { # Condition that uses `operator` to evaluate the key against the value.
+                  "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                  "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+          ],
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+          "label": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskNumber": "A String", # Task number of the next task.
+        },
+      ],
+      "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+        "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+        "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+          "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+            { # Key-value pair of EventBus parameters.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          ],
+        },
+        "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+      },
+      "triggerId": "A String", # The backend trigger ID.
+      "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+      "triggerType": "A String",
+    },
+  ],
+  "updateTime": "A String", # Output only. Auto-generated.
+  "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all IntegrationTemplateVersions in the specified project.
+
+Args:
+  parent: string, Required. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate} (required)
+  filter: string, Filter syntax: defined in the EBNF grammar.
+  pageSize: integer, The maximum number of IntegrationTemplateVersions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, A page token, received from a previous `ListIntegrationTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationTemplateVersions` 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 for IntegrationTemplateVersions.ListIntegrationTemplateVersions.
+  "integrationTemplateVersions": [ # The IntegrationTemplateVersions which match the request.
+    { # IntegrationTemplateVersion definition. An IntegrationTemplateVersion provides configurations required to construct an IntegrationVersion. It cannot be executed directly like an Integration. Users can create IntegrationTemplateVersions using Integrations. These Templates can be shared by users across GCP projects.
+      "createTime": "A String", # Output only. Auto-generated.
+      "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+      "description": "A String", # Optional. The templateversion description. Permitted format is alphanumeric with underscores and no spaces.
+      "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+      "name": "A String", # Output only. Auto-generated primary key. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}
+      "parentIntegrationVersionId": "A String", # Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion
+      "snapshotNumber": "A String", # Output only. An increasing sequence that is set when a new snapshot is created.
+      "status": "A String", # Optional. Generated by eventbus. User should not set it as an input.
+      "taskConfigs": [ # Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs.
+        { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+          "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+            { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+              "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+              "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+              "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+              "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+              "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "errorEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+              "metricType": "A String",
+              "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+              "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+              "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+                "absolute": "A String",
+                "percentage": 42,
+              },
+              "warningEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+            },
+          ],
+          "createTime": "A String", # Auto-generated.
+          "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+          "description": "A String", # User-provided description intended to give more business context about the task.
+          "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+          "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+            "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+            "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+          "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+          "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+          "lastModifiedTime": "A String", # Auto-generated.
+          "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+                { # This message recursively combines constituent conditions using logical AND.
+                  "conditions": [ # A set of individual constituent conditions.
+                    { # Condition that uses `operator` to evaluate the key against the value.
+                      "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                      "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                      "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                        "booleanValue": True or False,
+                        "doubleArray": {
+                          "values": [
+                            3.14,
+                          ],
+                        },
+                        "doubleValue": 3.14,
+                        "intArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "intValue": "A String",
+                        "protoValue": {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                        "stringArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "stringValue": "A String",
+                      },
+                    },
+                  ],
+                },
+              ],
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+              "label": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskNumber": "A String", # Task number of the next task.
+            },
+          ],
+          "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+          "parameters": { # The customized parameters the user can pass to this task.
+            "a_key": { # Key-value pair of EventBus parameters.
+              "dataType": "A String", # Explicitly getting the type of the parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+              "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": {
+                  "booleanValues": [
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "doubleValues": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "intValues": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "jsonValue": "A String",
+                "protoArray": {
+                  "protoValues": [
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                },
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "serializedObjectValue": {
+                  "objectValue": "A String",
+                },
+                "stringArray": {
+                  "stringValues": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+            },
+          },
+          "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+            "x": 42,
+            "y": 42,
+          },
+          "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+          "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+          "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+                { # Key-value pair of EventBus parameters.
+                  "dataType": "A String", # Explicitly getting the type of the parameter.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                  "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+            "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+              "A String",
+            ],
+          },
+          "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+            "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+          },
+          "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+            "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+            "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+            "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+            "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+              "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+              "admins": [
+                { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+                  "googleGroupEmail": "A String",
+                  "userEmail": "A String",
+                },
+              ],
+              "category": "A String",
+              "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+              "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+              "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+              "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+              "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+              "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+              "externalCategory": "A String",
+              "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+              "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+              "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+              "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+              "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+              "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+              "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+              "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+              "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+              "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+              "system": "A String",
+              "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+                "A String",
+              ],
+            },
+            "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+              "parameters": [
+                { # Key-value pair of EventBus task parameters. Next id: 13
+                  "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+                  "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+                  "config": { # Optional fields, such as help text and other useful info.
+                    "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                    "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                    "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                    "inputDisplayOption": "A String",
+                    "isHidden": True or False, # Whether this field is hidden in the UI.
+                    "label": "A String", # A user-friendly label for the parameter.
+                    "parameterNameOption": "A String",
+                    "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                    "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+                  },
+                  "dataType": "A String", # The data type of the parameter.
+                  "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "jsonValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                  "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+                  "isOutput": True or False,
+                  "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+                  "protoDef": { # Populated if this represents a proto or proto array.
+                    "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                    "path": "A String", # Path to the proto file that contains the message type's definition.
+                  },
+                  "required": True or False, # If set, the user must provide an input value for this parameter.
+                  "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                    "doubleRange": { # Range used to validate doubles and floats.
+                      "max": 3.14, # The inclusive maximum of the acceptable range.
+                      "min": 3.14, # The inclusive minimum of the acceptable range.
+                    },
+                    "intRange": { # Range used to validate longs and ints.
+                      "max": "A String", # The inclusive maximum of the acceptable range.
+                      "min": "A String", # The inclusive minimum of the acceptable range.
+                    },
+                    "stringRegex": { # Rule used to validate strings.
+                      "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                      "regex": "A String", # The regex applied to the input value(s).
+                    },
+                  },
+                },
+              ],
+            },
+            "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+              "dimensions": { # Dimensions that these stats have been aggregated on.
+                "clientId": "A String",
+                "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+                "errorEnumString": "A String",
+                "retryAttempt": "A String",
+                "taskName": "A String",
+                "taskNumber": "A String",
+                "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+                "warningEnumString": "A String",
+                "workflowId": "A String",
+                "workflowName": "A String",
+              },
+              "durationInSeconds": 3.14, # Average duration in seconds.
+              "errorRate": 3.14, # Average error rate.
+              "qps": 3.14, # Queries per second.
+              "warningRate": 3.14, # Average warning rate.
+            },
+            "taskType": "A String", # Defines the type of the task
+            "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+              "taskUiModuleConfigs": [ # Configurations of included config modules.
+                { # Task author would use this type to configure a config module.
+                  "moduleId": "A String", # ID of the config module.
+                },
+              ],
+            },
+          },
+          "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+          "taskName": "A String", # The name for the task.
+          "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+          "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+          "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+          "taskType": "A String", # Defines the type of the task
+        },
+      ],
+      "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+        "teardownTaskConfigs": [ # Required.
+          {
+            "creatorEmail": "A String", # The creator's email address.
+            "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+            "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+              "name": "A String", # Required. Name of the next teardown task.
+            },
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+              "properties": [ # An unordered list of property entries.
+                { # Key-value pair of EventBus property.
+                  "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+                  "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "values": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "stringArray": {
+                      "values": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+          },
+        ],
+      },
+      "templateParameters": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+        "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+          {
+            "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+              "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+              "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+                "booleanValue": True or False,
+                "doubleArray": {
+                  "values": [
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14,
+                "intArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "intValue": "A String",
+                "protoValue": {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+                "stringArray": {
+                  "values": [
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String",
+              },
+              "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+              "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+              "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+                "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+                "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+                  "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+                  "logType": [ # To which type(s) of logs the sanitize options apply.
+                    "A String",
+                  ],
+                  "privacy": "A String",
+                  "sanitizeType": "A String",
+                },
+                "seedPeriod": "A String",
+                "seedScope": "A String",
+                "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+                  "logAction": "A String",
+                  "logType": [ # To which type(s) of logs the limits apply.
+                    "A String",
+                  ],
+                  "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+                  "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+                  "shortenerType": "A String",
+                },
+              },
+              "searchable": "A String",
+              "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+                "A String",
+              ],
+            },
+            "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+              # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+            ],
+            "dataType": "A String", # The data type of the parameter.
+            "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "inOutType": "A String", # Specifies the input/output type for the parameter.
+            "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+            "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+            "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+              "elementIdentifier": "A String", # Configuration of the edge.
+              "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+            },
+            "producer": "A String",
+            "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+            "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+          },
+        ],
+      },
+      "triggerConfigs": [ # Optional. Trigger configurations.
+        { # Configuration detail of a trigger. Next available id: 16
+          "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+            { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+              "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+              "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+              "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+              "clientId": "A String", # Client associated with this alert configuration.
+              "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+              "errorEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+              "metricType": "A String",
+              "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+              "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+              "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+              "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+              "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+                "absolute": "A String",
+                "percentage": 42,
+              },
+              "warningEnumList": { # List of error enums for alerts.
+                "enumStrings": [
+                  "A String",
+                ],
+                "filterType": "A String",
+              },
+            },
+          ],
+          "description": "A String", # User-provided description intended to give more business context about the task.
+          "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+            "A String",
+          ],
+          "label": "A String", # The user created label for a particular trigger.
+          "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+          "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+          "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+            "x": 42,
+            "y": 42,
+          },
+          "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+            "a_key": "A String",
+          },
+          "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+                { # This message recursively combines constituent conditions using logical AND.
+                  "conditions": [ # A set of individual constituent conditions.
+                    { # Condition that uses `operator` to evaluate the key against the value.
+                      "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                      "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                      "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                        "booleanValue": True or False,
+                        "doubleArray": {
+                          "values": [
+                            3.14,
+                          ],
+                        },
+                        "doubleValue": 3.14,
+                        "intArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "intValue": "A String",
+                        "protoValue": {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                        "stringArray": {
+                          "values": [
+                            "A String",
+                          ],
+                        },
+                        "stringValue": "A String",
+                      },
+                    },
+                  ],
+                },
+              ],
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+              "label": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskNumber": "A String", # Task number of the next task.
+            },
+          ],
+          "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+            "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+            "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+              "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+                { # Key-value pair of EventBus parameters.
+                  "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                  "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                    "booleanArray": {
+                      "booleanValues": [
+                        True or False,
+                      ],
+                    },
+                    "booleanValue": True or False,
+                    "doubleArray": {
+                      "doubleValues": [
+                        3.14,
+                      ],
+                    },
+                    "doubleValue": 3.14,
+                    "intArray": {
+                      "intValues": [
+                        "A String",
+                      ],
+                    },
+                    "intValue": "A String",
+                    "protoArray": {
+                      "protoValues": [
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                    },
+                    "protoValue": {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                    "serializedObjectValue": {
+                      "objectValue": "A String",
+                    },
+                    "stringArray": {
+                      "stringValues": [
+                        "A String",
+                      ],
+                    },
+                    "stringValue": "A String",
+                  },
+                },
+              ],
+            },
+            "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+          },
+          "triggerId": "A String", # The backend trigger ID.
+          "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+          "triggerType": "A String",
+        },
+      ],
+      "updateTime": "A String", # Output only. Auto-generated.
+      "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+    },
+  ],
+  "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.
+}
+
+ +
+ 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/integrations_v1alpha.projects.locations.products.sfdcInstances.html b/docs/dyn/integrations_v1alpha.projects.locations.products.sfdcInstances.html new file mode 100644 index 00000000000..12ed426bf32 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.sfdcInstances.html @@ -0,0 +1,301 @@ + + + +

Application Integration API . projects . locations . products . sfdcInstances

+

Instance Methods

+

+ sfdcChannels() +

+

Returns the sfdcChannels Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

+

+ delete(name, x__xgafv=None)

+

Deletes an sfdc instance.

+

+ get(name, x__xgafv=None)

+

Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
+
+Args:
+  parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an sfdc instance.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcInstance. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcInstance. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
+
+Args:
+  parent: string, Required. The client, which owns this collection of SfdcInstances. (required)
+  filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+  pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+  pageToken: string, The token returned in the previous response.
+  readMask: string, The mask which specifies fields that need to be returned in the SfdcInstance's response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list SfdcInstances.
+  "nextPageToken": "A String", # The token used to retrieve the next page of results.
+  "sfdcInstances": [ # The list of SfdcInstances retrieved.
+    { # The SfdcInstance resource use to hold channels and connection config data.
+      "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+        "A String",
+      ],
+      "createTime": "A String", # Output only. Time when the instance is created
+      "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+      "description": "A String", # A description of the sfdc instance.
+      "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+      "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+      "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+      "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+      "updateTime": "A String", # Output only. Time when the instance was last updated
+    },
+  ],
+}
+
+ +
+ 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 an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
+
+Args:
+  name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+  updateMask: string, Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.sfdcInstances.sfdcChannels.html b/docs/dyn/integrations_v1alpha.projects.locations.products.sfdcInstances.sfdcChannels.html new file mode 100644 index 00000000000..37e3a96c0dc --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.sfdcInstances.sfdcChannels.html @@ -0,0 +1,284 @@ + + + +

Application Integration API . projects . locations . products . sfdcInstances . sfdcChannels

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.

+

+ delete(name, x__xgafv=None)

+

Deletes an sfdc channel.

+

+ get(name, x__xgafv=None)

+

Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
+
+Args:
+  parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an sfdc channel.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcChannel. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcChannel. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
+
+Args:
+  parent: string, Required. The client, which owns this collection of SfdcChannels. (required)
+  filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+  pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+  pageToken: string, The token returned in the previous response.
+  readMask: string, The mask which specifies fields that need to be returned in the SfdcChannel's response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list SfdcChannels.
+  "nextPageToken": "A String", # The token used to retrieve the next page of results.
+  "sfdcChannels": [ # The list of SfdcChannels retrieved.
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+      "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+      "createTime": "A String", # Output only. Time when the channel is created
+      "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+      "description": "A String", # The description for this channel
+      "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+      "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+      "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+      "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+      "updateTime": "A String", # Output only. Time when the channel was last updated
+    },
+  ],
+}
+
+ +
+ 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 an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
+
+Args:
+  name: string, Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+  updateMask: string, Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.html b/docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.html new file mode 100644 index 00000000000..672ff7d43ed --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.html @@ -0,0 +1,301 @@ + + + +

Application Integration API . projects . locations . sfdcInstances

+

Instance Methods

+

+ sfdcChannels() +

+

Returns the sfdcChannels Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

+

+ delete(name, x__xgafv=None)

+

Deletes an sfdc instance.

+

+ get(name, x__xgafv=None)

+

Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
+
+Args:
+  parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an sfdc instance.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcInstance. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcInstance. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
+
+Args:
+  parent: string, Required. The client, which owns this collection of SfdcInstances. (required)
+  filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+  pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+  pageToken: string, The token returned in the previous response.
+  readMask: string, The mask which specifies fields that need to be returned in the SfdcInstance's response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list SfdcInstances.
+  "nextPageToken": "A String", # The token used to retrieve the next page of results.
+  "sfdcInstances": [ # The list of SfdcInstances retrieved.
+    { # The SfdcInstance resource use to hold channels and connection config data.
+      "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+        "A String",
+      ],
+      "createTime": "A String", # Output only. Time when the instance is created
+      "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+      "description": "A String", # A description of the sfdc instance.
+      "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+      "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+      "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+      "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+      "updateTime": "A String", # Output only. Time when the instance was last updated
+    },
+  ],
+}
+
+ +
+ 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 an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
+
+Args:
+  name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+  updateMask: string, Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcInstance resource use to hold channels and connection config data.
+  "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+    "A String",
+  ],
+  "createTime": "A String", # Output only. Time when the instance is created
+  "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+  "description": "A String", # A description of the sfdc instance.
+  "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+  "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+  "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+  "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+  "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.sfdcChannels.html b/docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.sfdcChannels.html new file mode 100644 index 00000000000..ccc66cc7fc8 --- /dev/null +++ b/docs/dyn/integrations_v1alpha.projects.locations.sfdcInstances.sfdcChannels.html @@ -0,0 +1,284 @@ + + + +

Application Integration API . projects . locations . sfdcInstances . sfdcChannels

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.

+

+ delete(name, x__xgafv=None)

+

Deletes an sfdc channel.

+

+ get(name, x__xgafv=None)

+

Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
+
+Args:
+  parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an sfdc channel.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcChannel. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+  name: string, Required. The name that is associated with the SfdcChannel. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
+
+Args:
+  parent: string, Required. The client, which owns this collection of SfdcChannels. (required)
+  filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+  pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+  pageToken: string, The token returned in the previous response.
+  readMask: string, The mask which specifies fields that need to be returned in the SfdcChannel's response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to list SfdcChannels.
+  "nextPageToken": "A String", # The token used to retrieve the next page of results.
+  "sfdcChannels": [ # The list of SfdcChannels retrieved.
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+      "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+      "createTime": "A String", # Output only. Time when the channel is created
+      "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+      "description": "A String", # The description for this channel
+      "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+      "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+      "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+      "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+      "updateTime": "A String", # Output only. Time when the channel was last updated
+    },
+  ],
+}
+
+ +
+ 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 an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
+
+Args:
+  name: string, Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+  updateMask: string, Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The SfdcChannel that points to a CDC or Platform Event Channel.
+  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+  "createTime": "A String", # Output only. Time when the channel is created
+  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+  "description": "A String", # The description for this channel
+  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+  "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/manufacturers_v1.accounts.products.html b/docs/dyn/manufacturers_v1.accounts.products.html index df6de3986bd..71d538abea0 100644 --- a/docs/dyn/manufacturers_v1.accounts.products.html +++ b/docs/dyn/manufacturers_v1.accounts.products.html @@ -177,7 +177,7 @@

Method Details

"flavor": "A String", # The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor. "format": "A String", # The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format. "gender": "A String", # The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender. - "grocery": { # Grocery Attributes. For more information, see go/mfc-nutrition-attributes. + "grocery": { # Grocery Attributes. See more at https://support.google.com/manufacturers/answer/12098458#grocery. "activeIngredients": "A String", # Active ingredients. "alcoholByVolume": 3.14, # Alcohol by volume. "allergens": "A String", # Allergens. @@ -206,111 +206,111 @@

Method Details

"itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. - "nutrition": { # Nutrition Attributes. For more information, see go/mfc-nutrition-attributes. - "addedSugars": { # Combination of float amout and unit. # Added sugars. + "nutrition": { # Nutrition Attributes. See more at https://support.google.com/manufacturers/answer/12098458#food-servings. + "addedSugars": { # Combination of float amount and unit. # Added sugars. "amount": 3.14, # amount. "unit": "A String", # unit. }, "addedSugarsDailyPercentage": 3.14, # Added sugars daily percentage. - "calcium": { # Combination of float amout and unit. # Calcium. + "calcium": { # Combination of float amount and unit. # Calcium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "calciumDailyPercentage": 3.14, # Calcium daily percentage. - "cholesterol": { # Combination of float amout and unit. # Cholesterol. + "cholesterol": { # Combination of float amount and unit. # Cholesterol. "amount": 3.14, # amount. "unit": "A String", # unit. }, "cholesterolDailyPercentage": 3.14, # Cholesterol daily percentage. - "dietaryFiber": { # Combination of float amout and unit. # Dietary fiber. + "dietaryFiber": { # Combination of float amount and unit. # Dietary fiber. "amount": 3.14, # amount. "unit": "A String", # unit. }, "dietaryFiberDailyPercentage": 3.14, # Dietary fiber daily percentage. - "energy": { # Combination of float amout and unit. # Mandatory Nutrition Facts. Energy. + "energy": { # Combination of float amount and unit. # Mandatory Nutrition Facts. Energy. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "energyFromFat": { # Combination of float amout and unit. # Energy from fat. + "energyFromFat": { # Combination of float amount and unit. # Energy from fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "folateDailyPercentage": 3.14, # Folate daily percentage. - "folateFolicAcid": { # Combination of float amout and unit. # Folate folic acid. + "folateFolicAcid": { # Combination of float amount and unit. # Folate folic acid. "amount": 3.14, # amount. "unit": "A String", # unit. }, "folateMcgDfe": 3.14, # Folate mcg DFE. - "iron": { # Combination of float amout and unit. # Iron. + "iron": { # Combination of float amount and unit. # Iron. "amount": 3.14, # amount. "unit": "A String", # unit. }, "ironDailyPercentage": 3.14, # Iron daily percentage. - "monounsaturatedFat": { # Combination of float amout and unit. # Monounsaturated fat. + "monounsaturatedFat": { # Combination of float amount and unit. # Monounsaturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "nutritionFactMeasure": "A String", # Nutrition fact measure. - "polyols": { # Combination of float amout and unit. # Polyols. + "polyols": { # Combination of float amount and unit. # Polyols. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "polyunsaturatedFat": { # Combination of float amout and unit. # Polyunsaturated fat. + "polyunsaturatedFat": { # Combination of float amount and unit. # Polyunsaturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "potassium": { # Combination of float amout and unit. # Potassium. + "potassium": { # Combination of float amount and unit. # Potassium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "potassiumDailyPercentage": 3.14, # Potassium daily percentage. "preparedSizeDescription": "A String", # Prepared size description. - "protein": { # Combination of float amout and unit. # Protein. + "protein": { # Combination of float amount and unit. # Protein. "amount": 3.14, # amount. "unit": "A String", # unit. }, "proteinDailyPercentage": 3.14, # Protein daily percentage. - "saturatedFat": { # Combination of float amout and unit. # Saturated fat. + "saturatedFat": { # Combination of float amount and unit. # Saturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "saturatedFatDailyPercentage": 3.14, # Saturated fat daily percentage. "servingSizeDescription": "A String", # Food Serving Size. Serving size description. - "servingSizeMeasure": { # Combination of float amout and unit. # Serving size measure. + "servingSizeMeasure": { # Combination of float amount and unit. # Serving size measure. "amount": 3.14, # amount. "unit": "A String", # unit. }, "servingsPerContainer": "A String", # Servings per container. - "sodium": { # Combination of float amout and unit. # Sodium. + "sodium": { # Combination of float amount and unit. # Sodium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "sodiumDailyPercentage": 3.14, # Sodium daily percentage. - "starch": { # Combination of float amout and unit. # Starch. + "starch": { # Combination of float amount and unit. # Starch. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "totalCarbohydrate": { # Combination of float amout and unit. # Total carbohydrate. + "totalCarbohydrate": { # Combination of float amount and unit. # Total carbohydrate. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalCarbohydrateDailyPercentage": 3.14, # Total carbohydrate daily percentage. - "totalFat": { # Combination of float amout and unit. # Total fat. + "totalFat": { # Combination of float amount and unit. # Total fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalFatDailyPercentage": 3.14, # Total fat daily percentage. - "totalSugars": { # Combination of float amout and unit. # Total sugars. + "totalSugars": { # Combination of float amount and unit. # Total sugars. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalSugarsDailyPercentage": 3.14, # Total sugars daily percentage. - "transFat": { # Combination of float amout and unit. # Trans fat. + "transFat": { # Combination of float amount and unit. # Trans fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "transFatDailyPercentage": 3.14, # Trans fat daily percentage. - "vitaminD": { # Combination of float amout and unit. # Vitamin D. + "vitaminD": { # Combination of float amount and unit. # Vitamin D. "amount": 3.14, # amount. "unit": "A String", # unit. }, @@ -319,7 +319,7 @@

Method Details

{ # Voluntary Nutrition Facts. "dailyPercentage": 3.14, # Daily percentage. "name": "A String", # Name. - "value": { # Combination of float amout and unit. # Value. + "value": { # Combination of float amount and unit. # Value. "amount": 3.14, # amount. "unit": "A String", # unit. }, @@ -454,7 +454,7 @@

Method Details

"flavor": "A String", # The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor. "format": "A String", # The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format. "gender": "A String", # The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender. - "grocery": { # Grocery Attributes. For more information, see go/mfc-nutrition-attributes. + "grocery": { # Grocery Attributes. See more at https://support.google.com/manufacturers/answer/12098458#grocery. "activeIngredients": "A String", # Active ingredients. "alcoholByVolume": 3.14, # Alcohol by volume. "allergens": "A String", # Allergens. @@ -483,111 +483,111 @@

Method Details

"itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. - "nutrition": { # Nutrition Attributes. For more information, see go/mfc-nutrition-attributes. - "addedSugars": { # Combination of float amout and unit. # Added sugars. + "nutrition": { # Nutrition Attributes. See more at https://support.google.com/manufacturers/answer/12098458#food-servings. + "addedSugars": { # Combination of float amount and unit. # Added sugars. "amount": 3.14, # amount. "unit": "A String", # unit. }, "addedSugarsDailyPercentage": 3.14, # Added sugars daily percentage. - "calcium": { # Combination of float amout and unit. # Calcium. + "calcium": { # Combination of float amount and unit. # Calcium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "calciumDailyPercentage": 3.14, # Calcium daily percentage. - "cholesterol": { # Combination of float amout and unit. # Cholesterol. + "cholesterol": { # Combination of float amount and unit. # Cholesterol. "amount": 3.14, # amount. "unit": "A String", # unit. }, "cholesterolDailyPercentage": 3.14, # Cholesterol daily percentage. - "dietaryFiber": { # Combination of float amout and unit. # Dietary fiber. + "dietaryFiber": { # Combination of float amount and unit. # Dietary fiber. "amount": 3.14, # amount. "unit": "A String", # unit. }, "dietaryFiberDailyPercentage": 3.14, # Dietary fiber daily percentage. - "energy": { # Combination of float amout and unit. # Mandatory Nutrition Facts. Energy. + "energy": { # Combination of float amount and unit. # Mandatory Nutrition Facts. Energy. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "energyFromFat": { # Combination of float amout and unit. # Energy from fat. + "energyFromFat": { # Combination of float amount and unit. # Energy from fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "folateDailyPercentage": 3.14, # Folate daily percentage. - "folateFolicAcid": { # Combination of float amout and unit. # Folate folic acid. + "folateFolicAcid": { # Combination of float amount and unit. # Folate folic acid. "amount": 3.14, # amount. "unit": "A String", # unit. }, "folateMcgDfe": 3.14, # Folate mcg DFE. - "iron": { # Combination of float amout and unit. # Iron. + "iron": { # Combination of float amount and unit. # Iron. "amount": 3.14, # amount. "unit": "A String", # unit. }, "ironDailyPercentage": 3.14, # Iron daily percentage. - "monounsaturatedFat": { # Combination of float amout and unit. # Monounsaturated fat. + "monounsaturatedFat": { # Combination of float amount and unit. # Monounsaturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "nutritionFactMeasure": "A String", # Nutrition fact measure. - "polyols": { # Combination of float amout and unit. # Polyols. + "polyols": { # Combination of float amount and unit. # Polyols. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "polyunsaturatedFat": { # Combination of float amout and unit. # Polyunsaturated fat. + "polyunsaturatedFat": { # Combination of float amount and unit. # Polyunsaturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "potassium": { # Combination of float amout and unit. # Potassium. + "potassium": { # Combination of float amount and unit. # Potassium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "potassiumDailyPercentage": 3.14, # Potassium daily percentage. "preparedSizeDescription": "A String", # Prepared size description. - "protein": { # Combination of float amout and unit. # Protein. + "protein": { # Combination of float amount and unit. # Protein. "amount": 3.14, # amount. "unit": "A String", # unit. }, "proteinDailyPercentage": 3.14, # Protein daily percentage. - "saturatedFat": { # Combination of float amout and unit. # Saturated fat. + "saturatedFat": { # Combination of float amount and unit. # Saturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "saturatedFatDailyPercentage": 3.14, # Saturated fat daily percentage. "servingSizeDescription": "A String", # Food Serving Size. Serving size description. - "servingSizeMeasure": { # Combination of float amout and unit. # Serving size measure. + "servingSizeMeasure": { # Combination of float amount and unit. # Serving size measure. "amount": 3.14, # amount. "unit": "A String", # unit. }, "servingsPerContainer": "A String", # Servings per container. - "sodium": { # Combination of float amout and unit. # Sodium. + "sodium": { # Combination of float amount and unit. # Sodium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "sodiumDailyPercentage": 3.14, # Sodium daily percentage. - "starch": { # Combination of float amout and unit. # Starch. + "starch": { # Combination of float amount and unit. # Starch. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "totalCarbohydrate": { # Combination of float amout and unit. # Total carbohydrate. + "totalCarbohydrate": { # Combination of float amount and unit. # Total carbohydrate. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalCarbohydrateDailyPercentage": 3.14, # Total carbohydrate daily percentage. - "totalFat": { # Combination of float amout and unit. # Total fat. + "totalFat": { # Combination of float amount and unit. # Total fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalFatDailyPercentage": 3.14, # Total fat daily percentage. - "totalSugars": { # Combination of float amout and unit. # Total sugars. + "totalSugars": { # Combination of float amount and unit. # Total sugars. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalSugarsDailyPercentage": 3.14, # Total sugars daily percentage. - "transFat": { # Combination of float amout and unit. # Trans fat. + "transFat": { # Combination of float amount and unit. # Trans fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "transFatDailyPercentage": 3.14, # Trans fat daily percentage. - "vitaminD": { # Combination of float amout and unit. # Vitamin D. + "vitaminD": { # Combination of float amount and unit. # Vitamin D. "amount": 3.14, # amount. "unit": "A String", # unit. }, @@ -596,7 +596,7 @@

Method Details

{ # Voluntary Nutrition Facts. "dailyPercentage": 3.14, # Daily percentage. "name": "A String", # Name. - "value": { # Combination of float amout and unit. # Value. + "value": { # Combination of float amount and unit. # Value. "amount": 3.14, # amount. "unit": "A String", # unit. }, @@ -731,7 +731,7 @@

Method Details

"flavor": "A String", # The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor. "format": "A String", # The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format. "gender": "A String", # The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender. - "grocery": { # Grocery Attributes. For more information, see go/mfc-nutrition-attributes. + "grocery": { # Grocery Attributes. See more at https://support.google.com/manufacturers/answer/12098458#grocery. "activeIngredients": "A String", # Active ingredients. "alcoholByVolume": 3.14, # Alcohol by volume. "allergens": "A String", # Allergens. @@ -760,111 +760,111 @@

Method Details

"itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. - "nutrition": { # Nutrition Attributes. For more information, see go/mfc-nutrition-attributes. - "addedSugars": { # Combination of float amout and unit. # Added sugars. + "nutrition": { # Nutrition Attributes. See more at https://support.google.com/manufacturers/answer/12098458#food-servings. + "addedSugars": { # Combination of float amount and unit. # Added sugars. "amount": 3.14, # amount. "unit": "A String", # unit. }, "addedSugarsDailyPercentage": 3.14, # Added sugars daily percentage. - "calcium": { # Combination of float amout and unit. # Calcium. + "calcium": { # Combination of float amount and unit. # Calcium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "calciumDailyPercentage": 3.14, # Calcium daily percentage. - "cholesterol": { # Combination of float amout and unit. # Cholesterol. + "cholesterol": { # Combination of float amount and unit. # Cholesterol. "amount": 3.14, # amount. "unit": "A String", # unit. }, "cholesterolDailyPercentage": 3.14, # Cholesterol daily percentage. - "dietaryFiber": { # Combination of float amout and unit. # Dietary fiber. + "dietaryFiber": { # Combination of float amount and unit. # Dietary fiber. "amount": 3.14, # amount. "unit": "A String", # unit. }, "dietaryFiberDailyPercentage": 3.14, # Dietary fiber daily percentage. - "energy": { # Combination of float amout and unit. # Mandatory Nutrition Facts. Energy. + "energy": { # Combination of float amount and unit. # Mandatory Nutrition Facts. Energy. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "energyFromFat": { # Combination of float amout and unit. # Energy from fat. + "energyFromFat": { # Combination of float amount and unit. # Energy from fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "folateDailyPercentage": 3.14, # Folate daily percentage. - "folateFolicAcid": { # Combination of float amout and unit. # Folate folic acid. + "folateFolicAcid": { # Combination of float amount and unit. # Folate folic acid. "amount": 3.14, # amount. "unit": "A String", # unit. }, "folateMcgDfe": 3.14, # Folate mcg DFE. - "iron": { # Combination of float amout and unit. # Iron. + "iron": { # Combination of float amount and unit. # Iron. "amount": 3.14, # amount. "unit": "A String", # unit. }, "ironDailyPercentage": 3.14, # Iron daily percentage. - "monounsaturatedFat": { # Combination of float amout and unit. # Monounsaturated fat. + "monounsaturatedFat": { # Combination of float amount and unit. # Monounsaturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "nutritionFactMeasure": "A String", # Nutrition fact measure. - "polyols": { # Combination of float amout and unit. # Polyols. + "polyols": { # Combination of float amount and unit. # Polyols. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "polyunsaturatedFat": { # Combination of float amout and unit. # Polyunsaturated fat. + "polyunsaturatedFat": { # Combination of float amount and unit. # Polyunsaturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "potassium": { # Combination of float amout and unit. # Potassium. + "potassium": { # Combination of float amount and unit. # Potassium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "potassiumDailyPercentage": 3.14, # Potassium daily percentage. "preparedSizeDescription": "A String", # Prepared size description. - "protein": { # Combination of float amout and unit. # Protein. + "protein": { # Combination of float amount and unit. # Protein. "amount": 3.14, # amount. "unit": "A String", # unit. }, "proteinDailyPercentage": 3.14, # Protein daily percentage. - "saturatedFat": { # Combination of float amout and unit. # Saturated fat. + "saturatedFat": { # Combination of float amount and unit. # Saturated fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "saturatedFatDailyPercentage": 3.14, # Saturated fat daily percentage. "servingSizeDescription": "A String", # Food Serving Size. Serving size description. - "servingSizeMeasure": { # Combination of float amout and unit. # Serving size measure. + "servingSizeMeasure": { # Combination of float amount and unit. # Serving size measure. "amount": 3.14, # amount. "unit": "A String", # unit. }, "servingsPerContainer": "A String", # Servings per container. - "sodium": { # Combination of float amout and unit. # Sodium. + "sodium": { # Combination of float amount and unit. # Sodium. "amount": 3.14, # amount. "unit": "A String", # unit. }, "sodiumDailyPercentage": 3.14, # Sodium daily percentage. - "starch": { # Combination of float amout and unit. # Starch. + "starch": { # Combination of float amount and unit. # Starch. "amount": 3.14, # amount. "unit": "A String", # unit. }, - "totalCarbohydrate": { # Combination of float amout and unit. # Total carbohydrate. + "totalCarbohydrate": { # Combination of float amount and unit. # Total carbohydrate. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalCarbohydrateDailyPercentage": 3.14, # Total carbohydrate daily percentage. - "totalFat": { # Combination of float amout and unit. # Total fat. + "totalFat": { # Combination of float amount and unit. # Total fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalFatDailyPercentage": 3.14, # Total fat daily percentage. - "totalSugars": { # Combination of float amout and unit. # Total sugars. + "totalSugars": { # Combination of float amount and unit. # Total sugars. "amount": 3.14, # amount. "unit": "A String", # unit. }, "totalSugarsDailyPercentage": 3.14, # Total sugars daily percentage. - "transFat": { # Combination of float amout and unit. # Trans fat. + "transFat": { # Combination of float amount and unit. # Trans fat. "amount": 3.14, # amount. "unit": "A String", # unit. }, "transFatDailyPercentage": 3.14, # Trans fat daily percentage. - "vitaminD": { # Combination of float amout and unit. # Vitamin D. + "vitaminD": { # Combination of float amount and unit. # Vitamin D. "amount": 3.14, # amount. "unit": "A String", # unit. }, @@ -873,7 +873,7 @@

Method Details

{ # Voluntary Nutrition Facts. "dailyPercentage": 3.14, # Daily percentage. "name": "A String", # Name. - "value": { # Combination of float amout and unit. # Value. + "value": { # Combination of float amount and unit. # Value. "amount": 3.14, # amount. "unit": "A String", # unit. }, diff --git a/docs/dyn/mybusinesslodging_v1.locations.html b/docs/dyn/mybusinesslodging_v1.locations.html index e724e6820b0..6f35e9c9156 100644 --- a/docs/dyn/mybusinesslodging_v1.locations.html +++ b/docs/dyn/mybusinesslodging_v1.locations.html @@ -1134,8 +1134,8 @@

Method Details

"ecoCertificate": "A String", # Required. The eco certificate. }, ], - "leedCertification": "A String", # LEED certification. - "leedCertificationException": "A String", # LEED certification exception. + "leedCertification": "A String", # LEED certification. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. + "leedCertificationException": "A String", # LEED certification exception. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. }, "sustainableSourcing": { # Sustainable sourcing practices implemented at the hotel. # Sustainable sourcing practices implemented at the hotel. "ecoFriendlyToiletries": True or False, # Eco friendly toiletries. Soap, shampoo, lotion, and other toiletries provided for guests have a nationally or internationally recognized sustainability certification, such as USDA Organic, EU Organic, or cruelty-free. @@ -2281,8 +2281,8 @@

Method Details

"ecoCertificate": "A String", # Required. The eco certificate. }, ], - "leedCertification": "A String", # LEED certification. - "leedCertificationException": "A String", # LEED certification exception. + "leedCertification": "A String", # LEED certification. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. + "leedCertificationException": "A String", # LEED certification exception. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. }, "sustainableSourcing": { # Sustainable sourcing practices implemented at the hotel. # Sustainable sourcing practices implemented at the hotel. "ecoFriendlyToiletries": True or False, # Eco friendly toiletries. Soap, shampoo, lotion, and other toiletries provided for guests have a nationally or internationally recognized sustainability certification, such as USDA Organic, EU Organic, or cruelty-free. @@ -3427,8 +3427,8 @@

Method Details

"ecoCertificate": "A String", # Required. The eco certificate. }, ], - "leedCertification": "A String", # LEED certification. - "leedCertificationException": "A String", # LEED certification exception. + "leedCertification": "A String", # LEED certification. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. + "leedCertificationException": "A String", # LEED certification exception. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. }, "sustainableSourcing": { # Sustainable sourcing practices implemented at the hotel. # Sustainable sourcing practices implemented at the hotel. "ecoFriendlyToiletries": True or False, # Eco friendly toiletries. Soap, shampoo, lotion, and other toiletries provided for guests have a nationally or internationally recognized sustainability certification, such as USDA Organic, EU Organic, or cruelty-free. diff --git a/docs/dyn/mybusinesslodging_v1.locations.lodging.html b/docs/dyn/mybusinesslodging_v1.locations.lodging.html index 50c5a8d8830..003fc8c9c70 100644 --- a/docs/dyn/mybusinesslodging_v1.locations.lodging.html +++ b/docs/dyn/mybusinesslodging_v1.locations.lodging.html @@ -1128,8 +1128,8 @@

Method Details

"ecoCertificate": "A String", # Required. The eco certificate. }, ], - "leedCertification": "A String", # LEED certification. - "leedCertificationException": "A String", # LEED certification exception. + "leedCertification": "A String", # LEED certification. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. + "leedCertificationException": "A String", # LEED certification exception. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC. }, "sustainableSourcing": { # Sustainable sourcing practices implemented at the hotel. # Sustainable sourcing practices implemented at the hotel. "ecoFriendlyToiletries": True or False, # Eco friendly toiletries. Soap, shampoo, lotion, and other toiletries provided for guests have a nationally or internationally recognized sustainability certification, such as USDA Organic, EU Organic, or cruelty-free. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html index 9a4fee0e68a..fb4bd6d9872 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html @@ -274,7 +274,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -434,7 +434,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -476,7 +476,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.policyBasedRoutes.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.policyBasedRoutes.html index f5fc84603ed..71ee4d19cb0 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.policyBasedRoutes.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.policyBasedRoutes.html @@ -129,7 +129,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -172,7 +172,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -214,7 +214,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html index a0920011e88..3b7154ebdc2 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html @@ -306,7 +306,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -498,7 +498,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -540,7 +540,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index e5b983d8003..4cb423e84a4 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -126,8 +126,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -176,11 +176,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -328,8 +328,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -426,8 +426,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -476,11 +476,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -628,8 +628,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -681,7 +681,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -717,8 +717,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -767,11 +767,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -919,8 +919,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -967,8 +967,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -1017,11 +1017,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -1169,8 +1169,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -1287,7 +1287,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -1329,7 +1329,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index bea82bf6910..3f1cf28f803 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -126,8 +126,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -214,11 +214,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -367,8 +367,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -465,8 +465,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -553,11 +553,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -706,8 +706,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -759,7 +759,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -795,8 +795,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -883,11 +883,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -1036,8 +1036,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -1084,8 +1084,8 @@

Method Details

"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -1172,11 +1172,11 @@

Method Details

"resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudFunction": { # For display only. Metadata associated with a Cloud function. # Display information of a Cloud function. - "displayName": "A String", # Name of a Cloud function. - "location": "A String", # Location in which the Cloud function is deployed. - "uri": "A String", # URI of a Cloud function. - "versionId": "A String", # Latest successfully deployed version id of the Cloud function. + "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. + "displayName": "A String", # Name of a Cloud Function. + "location": "A String", # Location in which the Cloud Function is deployed. + "uri": "A String", # URI of a Cloud Function. + "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -1325,8 +1325,8 @@

Method Details

"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. - "cloudFunction": { # Wrapper for cloud function attributes. # A [Cloud function](https://cloud.google.com/functions). - "uri": "A String", # A [Cloud function](https://cloud.google.com/functions) name. + "cloudFunction": { # Wrapper for Cloud Function attributes. # A [Cloud Function](https://cloud.google.com/functions). + "uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). @@ -1443,7 +1443,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -1485,7 +1485,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.products.html b/docs/dyn/paymentsresellersubscription_v1.partners.products.html index 24bf3bdcf85..ce9e17d4236 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.products.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.products.html @@ -110,7 +110,7 @@

Method Details

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. "products": [ # The products for the specified partner. { # A Product resource that defines a subscription service that can be resold. - "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/products/{product_id}" + "name": "A String", # Output only. Response only. Resource name of the product. It will have the format of "partners/{partner_id}/products/{product_id}" "priceConfigs": [ # Output only. Price configs for the product in the available regions. { # Configs the prices in an available region. "amount": { # Describes the amount unit including the currency code. # Output only. The price in the region. diff --git a/docs/dyn/pubsub_v1.projects.snapshots.html b/docs/dyn/pubsub_v1.projects.snapshots.html index c97ce90c018..f76f63350db 100644 --- a/docs/dyn/pubsub_v1.projects.snapshots.html +++ b/docs/dyn/pubsub_v1.projects.snapshots.html @@ -115,12 +115,12 @@

Method Details

Creates a snapshot from the requested subscription. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.
 
 Args:
-  name: string, Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. (required)
+  name: string, Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format is `projects/{project}/snapshots/{snap}`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request for the `CreateSnapshot` method.
-  "labels": { # See Creating and managing labels.
+  "labels": { # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
     "a_key": "A String",
   },
   "subscription": "A String", # Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.
diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html
index e836c038643..51374c44c70 100644
--- a/docs/dyn/pubsub_v1.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1.projects.subscriptions.html
@@ -165,7 +165,7 @@ 

Method Details

The object takes the form of: { # A subscription resource. If none of `push_config` or `bigquery_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. - "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be *outstanding*. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. + "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. "bigqueryConfig": { # Configuration for a BigQuery subscription. # If delivery to BigQuery is used with this subscription, this field is used to configure it. "dropUnknownFields": True or False, # When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -184,13 +184,13 @@

Method Details

"ttl": "A String", # 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. }, "filter": "A String", # An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - "labels": { # See Creating and managing labels. + "labels": { # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). "a_key": "A String", }, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. - "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } + "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` "a_key": "A String", }, "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push). # If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. @@ -218,7 +218,7 @@

Method Details

An object of the form: { # A subscription resource. If none of `push_config` or `bigquery_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. - "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be *outstanding*. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. + "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. "bigqueryConfig": { # Configuration for a BigQuery subscription. # If delivery to BigQuery is used with this subscription, this field is used to configure it. "dropUnknownFields": True or False, # When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -237,13 +237,13 @@

Method Details

"ttl": "A String", # 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. }, "filter": "A String", # An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - "labels": { # See Creating and managing labels. + "labels": { # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). "a_key": "A String", }, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. - "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } + "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` "a_key": "A String", }, "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push). # If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. @@ -314,7 +314,7 @@

Method Details

An object of the form: { # A subscription resource. If none of `push_config` or `bigquery_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. - "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be *outstanding*. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. + "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. "bigqueryConfig": { # Configuration for a BigQuery subscription. # If delivery to BigQuery is used with this subscription, this field is used to configure it. "dropUnknownFields": True or False, # When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -333,13 +333,13 @@

Method Details

"ttl": "A String", # 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. }, "filter": "A String", # An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - "labels": { # See Creating and managing labels. + "labels": { # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). "a_key": "A String", }, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. - "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } + "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` "a_key": "A String", }, "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push). # If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. @@ -414,7 +414,7 @@

Method Details

"nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions. "subscriptions": [ # The subscriptions that match the request. { # A subscription resource. If none of `push_config` or `bigquery_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. - "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be *outstanding*. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. + "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. "bigqueryConfig": { # Configuration for a BigQuery subscription. # If delivery to BigQuery is used with this subscription, this field is used to configure it. "dropUnknownFields": True or False, # When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -433,13 +433,13 @@

Method Details

"ttl": "A String", # 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. }, "filter": "A String", # An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - "labels": { # See Creating and managing labels. + "labels": { # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). "a_key": "A String", }, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. - "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } + "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` "a_key": "A String", }, "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push). # If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. @@ -514,7 +514,7 @@

Method Details

{ # Request for the ModifyPushConfig method. "pushConfig": { # Configuration for a push delivery endpoint. # Required. The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called. - "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } + "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` "a_key": "A String", }, "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push). # If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. @@ -548,7 +548,7 @@

Method Details

{ # Request for the UpdateSubscription method. "subscription": { # A subscription resource. If none of `push_config` or `bigquery_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. # Required. The updated subscription object. - "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be *outstanding*. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. + "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. "bigqueryConfig": { # Configuration for a BigQuery subscription. # If delivery to BigQuery is used with this subscription, this field is used to configure it. "dropUnknownFields": True or False, # When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -567,13 +567,13 @@

Method Details

"ttl": "A String", # 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. }, "filter": "A String", # An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - "labels": { # See Creating and managing labels. + "labels": { # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). "a_key": "A String", }, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. - "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } + "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` "a_key": "A String", }, "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push). # If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. @@ -603,7 +603,7 @@

Method Details

An object of the form: { # A subscription resource. If none of `push_config` or `bigquery_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. - "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be *outstanding*. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. + "ackDeadlineSeconds": 42, # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. "bigqueryConfig": { # Configuration for a BigQuery subscription. # If delivery to BigQuery is used with this subscription, this field is used to configure it. "dropUnknownFields": True or False, # When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. @@ -622,13 +622,13 @@

Method Details

"ttl": "A String", # 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. }, "filter": "A String", # An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. - "labels": { # See Creating and managing labels. + "labels": { # See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). "a_key": "A String", }, "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. "name": "A String", # Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. - "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" } + "attributes": { # Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }` "a_key": "A String", }, "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push). # If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message. diff --git a/docs/dyn/realtimebidding_v1.bidders.creatives.html b/docs/dyn/realtimebidding_v1.bidders.creatives.html index 694ed20f9d9..60b1e97ee36 100644 --- a/docs/dyn/realtimebidding_v1.bidders.creatives.html +++ b/docs/dyn/realtimebidding_v1.bidders.creatives.html @@ -97,9 +97,9 @@

Method Details

Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
 
 Args:
-  parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)
+  parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, for example, for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)
   filter: string, Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
-  pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
+  pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
   pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.
   view: string, Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
     Allowed values
@@ -121,7 +121,7 @@ 

Method Details

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads. "advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method. "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve. @@ -137,8 +137,8 @@

Method Details

], }, "chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -150,7 +150,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -161,7 +161,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -197,8 +197,8 @@

Method Details

], }, "dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -210,7 +210,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -221,7 +221,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -287,8 +287,8 @@

Method Details

], "lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method. "networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -300,7 +300,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -311,7 +311,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -347,8 +347,8 @@

Method Details

], }, "platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -360,7 +360,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -371,7 +371,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -407,8 +407,8 @@

Method Details

], }, "russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -420,7 +420,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -431,7 +431,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -580,7 +580,7 @@

Method Details

An object of the form: { # A response for the request to receive push notification when a bidder's creatives change status. - "subscription": "A String", # The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Please use watchCreatives to re-enable the subscription. + "subscription": "A String", # The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Use watchCreatives to re-enable the subscription. "topic": "A String", # The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format `projects/{project_id}/topics/{topic_id}`. }
diff --git a/docs/dyn/realtimebidding_v1.bidders.html b/docs/dyn/realtimebidding_v1.bidders.html index 03be1890899..cceb0536844 100644 --- a/docs/dyn/realtimebidding_v1.bidders.html +++ b/docs/dyn/realtimebidding_v1.bidders.html @@ -127,7 +127,7 @@

Method Details

An object of the form: { # Bidder settings. - "bypassNonguaranteedDealsPretargeting": True or False, # Output only. A flag to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. + "bypassNonguaranteedDealsPretargeting": True or False, # Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. "cookieMatchingNetworkId": "A String", # Output only. The buyer's network ID used for cookie matching. This ID corresponds to the `google_nid` parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "cookieMatchingUrl": "A String", # Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "dealsBillingId": "A String", # Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting. @@ -153,7 +153,7 @@

Method Details

{ # A response containing bidders. "bidders": [ # List of bidders. { # Bidder settings. - "bypassNonguaranteedDealsPretargeting": True or False, # Output only. A flag to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. + "bypassNonguaranteedDealsPretargeting": True or False, # Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. "cookieMatchingNetworkId": "A String", # Output only. The buyer's network ID used for cookie matching. This ID corresponds to the `google_nid` parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "cookieMatchingUrl": "A String", # Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information. "dealsBillingId": "A String", # Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting. diff --git a/docs/dyn/realtimebidding_v1.bidders.publisherConnections.html b/docs/dyn/realtimebidding_v1.bidders.publisherConnections.html index 20654ade814..58f454171da 100644 --- a/docs/dyn/realtimebidding_v1.bidders.publisherConnections.html +++ b/docs/dyn/realtimebidding_v1.bidders.publisherConnections.html @@ -201,7 +201,7 @@

Method Details

parent: string, Required. Name of the bidder for which publishers have initiated connections. The pattern for this resource is `bidders/{bidder}` where `{bidder}` represents the account ID of the bidder. (required) filter: string, Query string to filter publisher connections. Connections can be filtered by `displayName`, `publisherPlatform`, and `biddingState`. If no filter is specified, all publisher connections will be returned. Example: 'displayName="Great Publisher*" AND publisherPlatform=ADMOB AND biddingState != PENDING' See https://google.aip.dev/160 for more information about filtering syntax. orderBy: string, Order specification by which results should be sorted. If no sort order is specified, the results will be returned in alphabetic order based on the publisher's publisher code. Results can be sorted by `createTime`. Example: 'createTime DESC'. - pageSize: integer, Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available via another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive. + pageSize: integer, Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available through another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive. pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListPublisherConnectionsResponse.nextPageToken returned from the previous call to the 'ListPublisherConnections' method. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/realtimebidding_v1.buyers.creatives.html b/docs/dyn/realtimebidding_v1.buyers.creatives.html index 41c6ed004b6..677cfd453fe 100644 --- a/docs/dyn/realtimebidding_v1.buyers.creatives.html +++ b/docs/dyn/realtimebidding_v1.buyers.creatives.html @@ -112,7 +112,7 @@

Method Details

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads. "advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method. "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve. @@ -128,8 +128,8 @@

Method Details

], }, "chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -141,7 +141,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -152,7 +152,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -188,8 +188,8 @@

Method Details

], }, "dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -201,7 +201,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -212,7 +212,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -278,8 +278,8 @@

Method Details

], "lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method. "networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -291,7 +291,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -302,7 +302,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -338,8 +338,8 @@

Method Details

], }, "platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -351,7 +351,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -362,7 +362,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -398,8 +398,8 @@

Method Details

], }, "russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -411,7 +411,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -422,7 +422,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -545,7 +545,7 @@

Method Details

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads. "advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method. "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve. @@ -561,8 +561,8 @@

Method Details

], }, "chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -574,7 +574,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -585,7 +585,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -621,8 +621,8 @@

Method Details

], }, "dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -634,7 +634,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -645,7 +645,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -711,8 +711,8 @@

Method Details

], "lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method. "networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -724,7 +724,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -735,7 +735,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -771,8 +771,8 @@

Method Details

], }, "platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -784,7 +784,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -795,7 +795,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -831,8 +831,8 @@

Method Details

], }, "russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -844,7 +844,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -855,7 +855,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -990,7 +990,7 @@

Method Details

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads. "advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method. "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve. @@ -1006,8 +1006,8 @@

Method Details

], }, "chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1019,7 +1019,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1030,7 +1030,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1066,8 +1066,8 @@

Method Details

], }, "dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1079,7 +1079,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1090,7 +1090,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1156,8 +1156,8 @@

Method Details

], "lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method. "networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1169,7 +1169,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1180,7 +1180,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1216,8 +1216,8 @@

Method Details

], }, "platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1229,7 +1229,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1240,7 +1240,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1276,8 +1276,8 @@

Method Details

], }, "russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1289,7 +1289,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1300,7 +1300,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1416,9 +1416,9 @@

Method Details

Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
 
 Args:
-  parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)
+  parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, for example, for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)
   filter: string, Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
-  pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
+  pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
   pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.
   view: string, Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
     Allowed values
@@ -1440,7 +1440,7 @@ 

Method Details

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads. "advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method. "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve. @@ -1456,8 +1456,8 @@

Method Details

], }, "chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1469,7 +1469,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1480,7 +1480,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1516,8 +1516,8 @@

Method Details

], }, "dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1529,7 +1529,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1540,7 +1540,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1606,8 +1606,8 @@

Method Details

], "lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method. "networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1619,7 +1619,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1630,7 +1630,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1666,8 +1666,8 @@

Method Details

], }, "platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1679,7 +1679,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1690,7 +1690,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1726,8 +1726,8 @@

Method Details

], }, "russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1739,7 +1739,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1750,7 +1750,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1892,7 +1892,7 @@

Method Details

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads. "advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method. "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve. @@ -1908,8 +1908,8 @@

Method Details

], }, "chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1921,7 +1921,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1932,7 +1932,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -1968,8 +1968,8 @@

Method Details

], }, "dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -1981,7 +1981,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -1992,7 +1992,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2058,8 +2058,8 @@

Method Details

], "lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method. "networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2071,7 +2071,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2082,7 +2082,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2118,8 +2118,8 @@

Method Details

], }, "platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2131,7 +2131,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2142,7 +2142,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2178,8 +2178,8 @@

Method Details

], }, "russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2191,7 +2191,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2202,7 +2202,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2326,7 +2326,7 @@

Method Details

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads. "advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. "agencyId": "A String", # The agency ID for this creative. - "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. + "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API. "creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method. "creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. "creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve. @@ -2342,8 +2342,8 @@

Method Details

], }, "chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2355,7 +2355,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2366,7 +2366,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2402,8 +2402,8 @@

Method Details

], }, "dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2415,7 +2415,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2426,7 +2426,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2492,8 +2492,8 @@

Method Details

], "lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method. "networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China). - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2505,7 +2505,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2516,7 +2516,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2552,8 +2552,8 @@

Method Details

], }, "platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2565,7 +2565,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2576,7 +2576,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. @@ -2612,8 +2612,8 @@

Method Details

], }, "russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction. - "status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method. - "topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED. + "status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method. + "topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED. { # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation. "evidences": [ # Pieces of evidence associated with this policy topic entry. { # Evidence associated with a policy topic entry. @@ -2625,7 +2625,7 @@

Method Details

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up. "dnsError": "A String", # DNS lookup errors. "expandedUrl": "A String", # The full non-working URL. - "httpError": 42, # HTTP error code (e.g. 404 or 5xx) + "httpError": 42, # HTTP error code (for example, 404 or 5xx) "invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page. "lastCheckTime": "A String", # Approximate time when the ad destination was last checked. "platform": "A String", # Platform of the non-working URL. @@ -2636,7 +2636,7 @@

Method Details

"destinationUrl": "A String", # The full landing page URL of the destination. }, "domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain. - "topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative. + "topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative. { # The number of HTTP calls made to the given domain. "domain": "A String", # The domain name. "httpCallCount": 42, # Number of HTTP calls made to the domain. diff --git a/docs/dyn/realtimebidding_v1.buyers.html b/docs/dyn/realtimebidding_v1.buyers.html index 4e3a7ca4744..3648ca79e30 100644 --- a/docs/dyn/realtimebidding_v1.buyers.html +++ b/docs/dyn/realtimebidding_v1.buyers.html @@ -120,7 +120,7 @@

Method Details

An object of the form: { # RTB Buyer account information. - "activeCreativeCount": "A String", # Output only. The number of creatives that this buyer submitted via the API or bid with in the last 30 days. This is counted against the maximum number of active creatives. + "activeCreativeCount": "A String", # Output only. The number of creatives that this buyer submitted through the API or bid with in the last 30 days. This is counted against the maximum number of active creatives. "bidder": "A String", # Output only. The name of the bidder resource that is responsible for receiving bidding traffic for this account. The bidder name must follow the pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the account ID of the bidder receiving traffic for this buyer. "billingIds": [ # Output only. A list of billing IDs associated with this account. These IDs appear on: 1. A bid request, to signal which buyers are eligible to bid on a given opportunity, and which pretargeting configurations were matched for each eligible buyer. 2. The bid response, to attribute a winning impression to a specific account for billing, reporting, policy and publisher block enforcement. "A String", @@ -168,7 +168,7 @@

Method Details

{ # A response containing buyer account information. "buyers": [ # List of buyers. { # RTB Buyer account information. - "activeCreativeCount": "A String", # Output only. The number of creatives that this buyer submitted via the API or bid with in the last 30 days. This is counted against the maximum number of active creatives. + "activeCreativeCount": "A String", # Output only. The number of creatives that this buyer submitted through the API or bid with in the last 30 days. This is counted against the maximum number of active creatives. "bidder": "A String", # Output only. The name of the bidder resource that is responsible for receiving bidding traffic for this account. The bidder name must follow the pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the account ID of the bidder receiving traffic for this buyer. "billingIds": [ # Output only. A list of billing IDs associated with this account. These IDs appear on: 1. A bid request, to signal which buyers are eligible to bid on a given opportunity, and which pretargeting configurations were matched for each eligible buyer. 2. The bid response, to attribute a winning impression to a specific account for billing, reporting, policy and publisher block enforcement. "A String", diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html index 3c340f36750..da3ec4482be 100644 --- a/docs/dyn/run_v1.namespaces.configurations.html +++ b/docs/dyn/run_v1.namespaces.configurations.html @@ -227,7 +227,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -558,7 +558,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index 8994fd2ee7e..c5d3bfc2937 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -203,7 +203,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -543,7 +543,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -844,7 +844,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index 37aa806c796..15b2eaaf031 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -237,7 +237,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -555,7 +555,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -924,7 +924,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -1259,7 +1259,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -1590,7 +1590,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -1908,7 +1908,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -2205,7 +2205,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index a6238df18fd..522f37e3c23 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -241,7 +241,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -537,7 +537,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 623573c7bce..71ee7c2f63b 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -231,7 +231,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -570,7 +570,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -960,7 +960,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -1315,7 +1315,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -1666,7 +1666,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -2005,7 +2005,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index d07dfc20485..d77a1a6f1f6 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -192,7 +192,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -496,7 +496,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index 9a27f268312..9f99b3a08c2 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -227,7 +227,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -558,7 +558,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 293b0810cf2..238e84f44f0 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -241,7 +241,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -537,7 +537,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index e4b4bb6bf77..bc987bea9b9 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -240,7 +240,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -579,7 +579,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -969,7 +969,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -1372,7 +1372,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -1723,7 +1723,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", @@ -2062,7 +2062,7 @@

Method Details

], "image": "A String", # Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - "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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Not supported by Cloud Run. "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run. "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. "A String", diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 0aa594d75b5..c178928c6a0 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -230,7 +230,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -426,6 +426,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -593,7 +594,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -789,6 +790,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -919,7 +921,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1115,6 +1117,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -1258,7 +1261,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1454,6 +1457,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -1598,7 +1602,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1794,6 +1798,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index b8812b4bf87..15119c73d8d 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -163,7 +163,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -359,6 +359,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -489,7 +490,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -685,6 +686,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -886,7 +888,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1082,6 +1084,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -1249,7 +1252,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1445,6 +1448,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -1575,7 +1579,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1771,6 +1775,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -1914,7 +1919,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -2110,6 +2115,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -2254,7 +2260,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -2450,6 +2456,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index c2b3fd73252..5a9b374dfb4 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -230,7 +230,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -426,6 +426,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -593,7 +594,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -789,6 +790,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -919,7 +921,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1115,6 +1117,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -1258,7 +1261,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1454,6 +1457,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. @@ -1598,7 +1602,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } + "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1794,6 +1798,7 @@

Method Details

"name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" "nextSteps": "A String", # Next steps associate to the finding. "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". "processes": [ # Represents operating system processes associated with the Finding. { # Represents an operating system process. "args": [ # Process arguments as JSON encoded strings. diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index e972feaecbb..de85a2b82bb 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -420,8 +420,8 @@

Method Details

}, "name": "A String", # The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. "producerProjectId": "A String", # The Google project that owns this service. - "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. - "limits": [ # List of `QuotaLimit` definitions for the service. + "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. + "limits": [ # List of QuotaLimit definitions for the service. { # `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. "defaultLimit": "A String", # Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. "description": "A String", # Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). @@ -437,7 +437,7 @@

Method Details

}, }, ], - "metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. + "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", @@ -886,8 +886,8 @@

Method Details

}, "name": "A String", # The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. "producerProjectId": "A String", # The Google project that owns this service. - "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. - "limits": [ # List of `QuotaLimit` definitions for the service. + "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. + "limits": [ # List of QuotaLimit definitions for the service. { # `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. "defaultLimit": "A String", # Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. "description": "A String", # Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). @@ -903,7 +903,7 @@

Method Details

}, }, ], - "metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. + "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", @@ -1364,8 +1364,8 @@

Method Details

}, "name": "A String", # The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. "producerProjectId": "A String", # The Google project that owns this service. - "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. - "limits": [ # List of `QuotaLimit` definitions for the service. + "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. + "limits": [ # List of QuotaLimit definitions for the service. { # `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. "defaultLimit": "A String", # Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. "description": "A String", # Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). @@ -1381,7 +1381,7 @@

Method Details

}, }, ], - "metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. + "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", @@ -1842,8 +1842,8 @@

Method Details

}, "name": "A String", # The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. "producerProjectId": "A String", # The Google project that owns this service. - "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. - "limits": [ # List of `QuotaLimit` definitions for the service. + "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. + "limits": [ # List of QuotaLimit definitions for the service. { # `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. "defaultLimit": "A String", # Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. "description": "A String", # Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). @@ -1859,7 +1859,7 @@

Method Details

}, }, ], - "metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. + "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index e744e3c3423..d744819087f 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -615,8 +615,8 @@

Method Details

}, "name": "A String", # The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. "producerProjectId": "A String", # The Google project that owns this service. - "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. - "limits": [ # List of `QuotaLimit` definitions for the service. + "quota": { # Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Quota configuration. + "limits": [ # List of QuotaLimit definitions for the service. { # `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`. "defaultLimit": "A String", # Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. "description": "A String", # Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). @@ -632,7 +632,7 @@

Method Details

}, }, ], - "metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. + "metricRules": [ # List of MetricRule definitions, each one mapping a selected method to one or more metrics. { # Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. "metricCosts": { # Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative. "a_key": "A String", diff --git a/docs/dyn/slides_v1.presentations.html b/docs/dyn/slides_v1.presentations.html index 0847214e996..0013f68370e 100644 --- a/docs/dyn/slides_v1.presentations.html +++ b/docs/dyn/slides_v1.presentations.html @@ -777,1014 +777,7 @@

Method Details

"isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": { # A page in a presentation. # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - "layoutProperties": { # The properties of Page are only relevant for pages with page_type LAYOUT. # Layout specific properties. Only set if page_type = LAYOUT. - "displayName": "A String", # The human-readable name of the layout. - "masterObjectId": "A String", # The object ID of the master that this layout is based on. - "name": "A String", # The name of the layout. - }, - "masterProperties": { # The properties of Page that are only relevant for pages with page_type MASTER. # Master specific properties. Only set if page_type = MASTER. - "displayName": "A String", # The human-readable name of the master. - }, - "notesProperties": { # The properties of Page that are only relevant for pages with page_type NOTES. # Notes specific properties. Only set if page_type = NOTES. - "speakerNotesObjectId": "A String", # The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID. - }, - "objectId": "A String", # The object ID for this page. Object IDs used by Page and PageElement share the same namespace. - "pageElements": [ # The page elements rendered on the page. - { # A visual element rendered on a page. - "description": "A String", # The description of the page element. Combined with title to display alt text. The field is not supported for Group elements. - "elementGroup": { # A PageElement kind representing a joined collection of PageElements. # A collection of page elements joined as a single unit. - "children": [ # The collection of elements in the group. The minimum size of a group is 2. - # Object with schema name: PageElement - ], - }, - "image": { # A PageElement kind representing an image. # An image page element. - "contentUrl": "A String", # An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. - "imageProperties": { # The properties of the Image. # The properties of the image. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. - "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. - "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. - "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. - "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. - "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. - "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. - }, - "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. - "dashStyle": "A String", # The dash style of the outline. - "outlineFill": { # The fill of the outline. # The fill of the outline. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. - "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. - "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. - "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. - { # A color and position in a gradient band. - "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. - "color": { # A themeable solid color value. # The color of the gradient stop. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. - }, - ], - }, - "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. - "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. - "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. - "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "color": { # A themeable solid color value. # The shadow color value. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. - "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. - "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. - "scaleX": 3.14, # The X coordinate scaling element. - "scaleY": 3.14, # The Y coordinate scaling element. - "shearX": 3.14, # The X coordinate shearing element. - "shearY": 3.14, # The Y coordinate shearing element. - "translateX": 3.14, # The X coordinate translation element. - "translateY": 3.14, # The Y coordinate translation element. - "unit": "A String", # The units for translate elements. - }, - "type": "A String", # The type of the shadow. This property is read-only. - }, - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. - }, - "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the image is a placeholder image and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. - "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. - "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. - "type": "A String", # The type of the placeholder. - }, - "sourceUrl": "A String", # The source URL is the URL used to insert the image. The source URL can be empty. - }, - "line": { # A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector. # A line page element. - "lineCategory": "A String", # The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest. - "lineProperties": { # The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor. # The properties of the line. - "dashStyle": "A String", # The dash style of the line. - "endArrow": "A String", # The style of the arrow at the end of the line. - "endConnection": { # The properties for one end of a Line connection. # The connection at the end of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have an `end_connection`. - "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. - "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. - }, - "lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new lines created in the Slides editor. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - "link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "startArrow": "A String", # The style of the arrow at the beginning of the line. - "startConnection": { # The properties for one end of a Line connection. # The connection at the beginning of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have a `start_connection`. - "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. - "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. - }, - "weight": { # A magnitude in a single direction in the specified units. # The thickness of the line. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "lineType": "A String", # The type of the line. - }, - "objectId": "A String", # The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace. - "shape": { # A PageElement kind representing a generic shape that does not have a more specific classification. # A generic shape. - "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the shape is a placeholder shape and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. - "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. - "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. - "type": "A String", # The type of the placeholder. - }, - "shapeProperties": { # The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape. # The properties of the shape. - "autofit": { # The autofit properties of a Shape. # The autofit properties of the shape. This property is only set for shapes that allow text. - "autofitType": "A String", # The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values. - "fontScale": 3.14, # The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that is rendered in the editor. This property is read-only. - "lineSpacingReduction": 3.14, # The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that is rendered in the editor. This property is read-only. - }, - "contentAlignment": "A String", # The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor. - "link": { # A hypertext link. # The hyperlink destination of the shape. If unset, there is no link. Links are not inherited from parent placeholders. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the shape. If unset, the outline is inherited from a parent placeholder if it exists. If the shape has no parent, then the default outline depends on the shape type, matching the defaults for new shapes created in the Slides editor. - "dashStyle": "A String", # The dash style of the outline. - "outlineFill": { # The fill of the outline. # The fill of the outline. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. - "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow properties of the shape. If unset, the shadow is inherited from a parent placeholder if it exists. If the shape has no parent, then the default shadow matches the defaults for new shapes created in the Slides editor. This property is read-only. - "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. - "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. - "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "color": { # A themeable solid color value. # The shadow color value. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. - "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. - "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. - "scaleX": 3.14, # The X coordinate scaling element. - "scaleY": 3.14, # The Y coordinate scaling element. - "shearX": 3.14, # The X coordinate shearing element. - "shearY": 3.14, # The Y coordinate shearing element. - "translateX": 3.14, # The X coordinate translation element. - "translateY": 3.14, # The Y coordinate translation element. - "unit": "A String", # The units for translate elements. - }, - "type": "A String", # The type of the shadow. This property is read-only. - }, - "shapeBackgroundFill": { # The shape background fill. # The background fill of the shape. If unset, the background fill is inherited from a parent placeholder if it exists. If the shape has no parent, then the default background fill depends on the shape type, matching the defaults for new shapes created in the Slides editor. - "propertyState": "A String", # The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - }, - "shapeType": "A String", # The type of the shape. - "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the shape. - "lists": { # The bulleted lists contained in this text, keyed by list ID. - "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. - "listId": "A String", # The ID of the list. - "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. - "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. - "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - }, - }, - }, - }, - "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. - { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. - "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. - "content": "A String", # The rendered content of this auto text, if available. - "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - "type": "A String", # The type of this auto text. - }, - "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. - "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - "glyph": "A String", # The rendered bullet glyph for this paragraph. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - }, - "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style - "alignment": "A String", # The text alignment for this paragraph. - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - }, - }, - "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. - "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. - "content": "A String", # The text of this run. - "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - }, - }, - ], - }, - }, - "sheetsChart": { # A PageElement kind representing a linked chart embedded from Google Sheets. # A linked chart embedded from Google Sheets. Unlinked charts are represented as images. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is embedded. - "contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. - "sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart. - "chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. - "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. - "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. - "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. - "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. - "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. - "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. - }, - "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. - "dashStyle": "A String", # The dash style of the outline. - "outlineFill": { # The fill of the outline. # The fill of the outline. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. - "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. - "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. - "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. - { # A color and position in a gradient band. - "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. - "color": { # A themeable solid color value. # The color of the gradient stop. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. - }, - ], - }, - "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. - "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. - "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. - "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "color": { # A themeable solid color value. # The shadow color value. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. - "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. - "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. - "scaleX": 3.14, # The X coordinate scaling element. - "scaleY": 3.14, # The Y coordinate scaling element. - "shearX": 3.14, # The X coordinate shearing element. - "shearY": 3.14, # The Y coordinate shearing element. - "translateX": 3.14, # The X coordinate translation element. - "translateY": 3.14, # The Y coordinate translation element. - "unit": "A String", # The units for translate elements. - }, - "type": "A String", # The type of the shadow. This property is read-only. - }, - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. - }, - }, - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - "size": { # A width and height. # The size of the page element. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "table": { # A PageElement kind representing a table. # A table page element. - "columns": 42, # Number of columns in the table. - "horizontalBorderRows": [ # Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns. - { # Contents of each border row in a table. - "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. - { # The properties of each border cell. - "location": { # A location of a single table cell within a table. # The location of the border within the border table. - "columnIndex": 42, # The 0-based column index. - "rowIndex": 42, # The 0-based row index. - }, - "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. - "dashStyle": "A String", # The dash style of the border. - "tableBorderFill": { # The fill of the border. # The fill of the table border. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - ], - }, - ], - "rows": 42, # Number of rows in the table. - "tableColumns": [ # Properties of each column. - { # Properties of each column in a table. - "columnWidth": { # A magnitude in a single direction in the specified units. # Width of a column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "tableRows": [ # Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1. - { # Properties and contents of each row in a table. - "rowHeight": { # A magnitude in a single direction in the specified units. # Height of a row. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "tableCells": [ # Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table. - { # Properties and contents of each table cell. - "columnSpan": 42, # Column span of the cell. - "location": { # A location of a single table cell within a table. # The location of the cell within the table. - "columnIndex": 42, # The 0-based column index. - "rowIndex": 42, # The 0-based row index. - }, - "rowSpan": 42, # Row span of the cell. - "tableCellProperties": { # The properties of the TableCell. # The properties of the table cell. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor. - "tableCellBackgroundFill": { # The table cell background fill. # The background fill of the table cell. The default fill matches the fill for newly created table cells in the Slides editor. - "propertyState": "A String", # The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - }, - "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the cell. - "lists": { # The bulleted lists contained in this text, keyed by list ID. - "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. - "listId": "A String", # The ID of the list. - "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. - "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. - "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - }, - }, - }, - }, - "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. - { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. - "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. - "content": "A String", # The rendered content of this auto text, if available. - "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - "type": "A String", # The type of this auto text. - }, - "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. - "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - "glyph": "A String", # The rendered bullet glyph for this paragraph. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - }, - "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style - "alignment": "A String", # The text alignment for this paragraph. - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - }, - }, - "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. - "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. - "content": "A String", # The text of this run. - "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. - "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. - "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. - "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. - "url": "A String", # If set, indicates this is a link to the external web page at this URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). - }, - }, - }, - }, - ], - }, - }, - ], - "tableRowProperties": { # Properties of each row in a table. # Properties of the row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # Minimum height of the row. The row will be rendered in the Slides editor at a height equal to or greater than this value in order to show all the text in the row's cell(s). - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - ], - "verticalBorderRows": [ # Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns. - { # Contents of each border row in a table. - "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. - { # The properties of each border cell. - "location": { # A location of a single table cell within a table. # The location of the border within the border table. - "columnIndex": 42, # The 0-based column index. - "rowIndex": 42, # The 0-based row index. - }, - "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. - "dashStyle": "A String", # The dash style of the border. - "tableBorderFill": { # The fill of the border. # The fill of the table border. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - ], - }, - ], - }, - "title": "A String", # The title of the page element. Combined with description to display alt text. The field is not supported for Group elements. - "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # The transform of the page element. The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field. The initial transform for the newly created Group is always the identity transform. - "scaleX": 3.14, # The X coordinate scaling element. - "scaleY": 3.14, # The Y coordinate scaling element. - "shearX": 3.14, # The X coordinate shearing element. - "shearY": 3.14, # The Y coordinate shearing element. - "translateX": 3.14, # The X coordinate translation element. - "translateY": 3.14, # The Y coordinate translation element. - "unit": "A String", # The units for translate elements. - }, - "video": { # A PageElement kind representing a video. # A video page element. - "id": "A String", # The video source's unique identifier for this video. - "source": "A String", # The video source. - "url": "A String", # An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change. - "videoProperties": { # The properties of the Video. # The properties of the video. - "autoPlay": True or False, # Whether to enable video autoplay when the page is displayed in present mode. Defaults to false. - "end": 42, # The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end. - "mute": True or False, # Whether to mute the audio during video playback. Defaults to false. - "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the video. The default outline matches the defaults for new videos created in the Slides editor. - "dashStyle": "A String", # The dash style of the outline. - "outlineFill": { # The fill of the outline. # The fill of the outline. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - }, - "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. - "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "start": 42, # The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning. - }, - }, - "wordArt": { # A PageElement kind representing word art. # A word art page element. - "renderedText": "A String", # The text rendered as word art. - }, - }, - ], - "pageProperties": { # The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties. # The properties of the page. - "colorScheme": { # The palette of predefined colors for a page. # The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme, matching the defaults in the Slides editor. Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only the color scheme on `Master` pages can be updated. To update the field, a color scheme containing mappings from all the first 12 ThemeColorTypes to their concrete colors must be provided. Colors for the remaining ThemeColorTypes will be ignored. - "colors": [ # The ThemeColorType and corresponding concrete color pairs. - { # A pair mapping a theme color type to the concrete color it represents. - "color": { # An RGB color. # The concrete color corresponding to the theme color type above. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "type": "A String", # The type of the theme color. - }, - ], - }, - "pageBackgroundFill": { # The page background fill. # The background fill of the page. If unset, the background fill is inherited from a parent page if it exists. If the page has no parent, then the background fill defaults to the corresponding fill in the Slides editor. - "propertyState": "A String", # The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. - "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. - "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. - "color": { # A themeable solid color value. # The color value of the solid fill. - "rgbColor": { # An RGB color. # An opaque RGB color. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - "themeColor": "A String", # An opaque theme color. - }, - }, - "stretchedPictureFill": { # The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container. # Stretched picture fill. - "contentUrl": "A String", # Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. - "size": { # A width and height. # The original size of the picture fill. This field is read-only. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - }, - }, - "pageType": "A String", # The type of the page. - "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. - }, + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. }, }, "updateSlidesPosition": { # Updates the position of slides in the presentation. # Updates the position of a set of slides in the presentation. @@ -3052,7 +2045,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -4063,7 +3061,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -5072,7 +4075,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -6093,7 +5101,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "title": "A String", # The title of the presentation. @@ -7115,7 +6128,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -8126,7 +7144,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -9135,7 +8158,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -10156,7 +9184,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "title": "A String", # The title of the presentation. @@ -11185,7 +10218,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -12196,7 +11234,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -13205,7 +12248,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -14226,7 +13274,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }, ], "title": "A String", # The title of the presentation. diff --git a/docs/dyn/slides_v1.presentations.pages.html b/docs/dyn/slides_v1.presentations.pages.html index d6c583bb80b..7671a5028bb 100644 --- a/docs/dyn/slides_v1.presentations.pages.html +++ b/docs/dyn/slides_v1.presentations.pages.html @@ -1110,7 +1110,12 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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 presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. + "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. + "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. + "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. + "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + }, }
diff --git a/docs/dyn/spanner_v1.projects.html b/docs/dyn/spanner_v1.projects.html index 7c9c6e96229..b9891a28e28 100644 --- a/docs/dyn/spanner_v1.projects.html +++ b/docs/dyn/spanner_v1.projects.html @@ -74,6 +74,11 @@

Cloud Spanner API . projects

Instance Methods

+

+ instanceConfigOperations() +

+

Returns the instanceConfigOperations Resource.

+

instanceConfigs()

diff --git a/docs/dyn/spanner_v1.projects.instanceConfigOperations.html b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html new file mode 100644 index 00000000000..4d4f3ef2874 --- /dev/null +++ b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html @@ -0,0 +1,149 @@ + + + +

Cloud Spanner API . projects . instanceConfigOperations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.
+
+Args:
+  parent: string, Required. The project of the instance config operations. Values are of the form `projects/`. (required)
+  filter: string, An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
+  pageSize: integer, Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
+  pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same `parent` and with the same `filter`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for ListInstanceConfigOperations.
+  "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListInstanceConfigOperations call to fetch more of the matching metadata.
+  "operations": [ # The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.
+    { # 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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ 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/spanner_v1.projects.instanceConfigs.html b/docs/dyn/spanner_v1.projects.instanceConfigs.html index 71f1e00cdff..854b5f14727 100644 --- a/docs/dyn/spanner_v1.projects.instanceConfigs.html +++ b/docs/dyn/spanner_v1.projects.instanceConfigs.html @@ -82,6 +82,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.

+

+ delete(name, etag=None, validateOnly=None, x__xgafv=None)

+

Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.

get(name, x__xgafv=None)

Gets information about a particular instance configuration.

@@ -91,12 +97,108 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
+
+Args:
+  parent: string, Required. The name of the project in which to create the instance config. Values are of the form `projects/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for CreateInstanceConfigRequest.
+  "instanceConfig": { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. # Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3.
+    "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
+    "configType": "A String", # Output only. Whether this instance config is a Google or User Managed Configuration.
+    "displayName": "A String", # The name of this instance configuration as it appears in UIs.
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
+    "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config.
+    "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
+      "a_key": "A String",
+    },
+    "leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
+      "A String",
+    ],
+    "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
+    "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
+      {
+        "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
+        "location": "A String", # The location of the serving resources, e.g. "us-central1".
+        "type": "A String", # The type of replica.
+      },
+    ],
+    "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
+    "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties.
+      {
+        "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
+        "location": "A String", # The location of the serving resources, e.g. "us-central1".
+        "type": "A String", # The type of replica.
+      },
+    ],
+    "state": "A String", # Output only. The current instance config state.
+  },
+  "instanceConfigId": "A String", # Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations.
+  "validateOnly": True or False, # An option to validate, but not actually execute, a request, and provide the same response.
+}
+
+  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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, validateOnly=None, x__xgafv=None) +
Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.
+
+Args:
+  name: string, Required. The name of the instance configuration to be deleted. Values are of the form `projects//instanceConfigs/` (required)
+  etag: string, Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.
+  validateOnly: boolean, An option to validate, but not actually execute, a request, and provide the same response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
Gets information about a particular instance configuration.
@@ -112,12 +214,26 @@ 

Method Details

An object of the form: { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. + "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration. + "configType": "A String", # Output only. Whether this instance config is a Google or User Managed Configuration. "displayName": "A String", # The name of this instance configuration as it appears in UIs. + "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. + "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. + "a_key": "A String", + }, "leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + { + "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. + "location": "A String", # The location of the serving resources, e.g. "us-central1". + "type": "A String", # The type of replica. + }, + ], + "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. { "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. @@ -125,6 +241,7 @@

Method Details

"type": "A String", # The type of replica. }, ], + "state": "A String", # Output only. The current instance config state. }
@@ -147,12 +264,26 @@

Method Details

{ # The response for ListInstanceConfigs. "instanceConfigs": [ # The list of requested instance configurations. { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. + "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration. + "configType": "A String", # Output only. Whether this instance config is a Google or User Managed Configuration. "displayName": "A String", # The name of this instance configuration as it appears in UIs. + "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. + "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. + "a_key": "A String", + }, "leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + { + "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. + "location": "A String", # The location of the serving resources, e.g. "us-central1". + "type": "A String", # The type of replica. + }, + ], + "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. { "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. @@ -160,6 +291,7 @@

Method Details

"type": "A String", # The type of replica. }, ], + "state": "A String", # Output only. The current instance config state. }, ], "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations. @@ -180,4 +312,77 @@

Method Details

+
+ patch(name, body=None, x__xgafv=None) +
Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
+
+Args:
+  name: string, A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for UpdateInstanceConfigRequest.
+  "instanceConfig": { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. # Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used.
+    "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
+    "configType": "A String", # Output only. Whether this instance config is a Google or User Managed Configuration.
+    "displayName": "A String", # The name of this instance configuration as it appears in UIs.
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
+    "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config.
+    "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
+      "a_key": "A String",
+    },
+    "leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
+      "A String",
+    ],
+    "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
+    "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
+      {
+        "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
+        "location": "A String", # The location of the serving resources, e.g. "us-central1".
+        "type": "A String", # The type of replica.
+      },
+    ],
+    "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
+    "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties.
+      {
+        "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
+        "location": "A String", # The location of the serving resources, e.g. "us-central1".
+        "type": "A String", # The type of replica.
+      },
+    ],
+    "state": "A String", # Output only. The current instance config state.
+  },
+  "updateMask": "A String", # Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.
+  "validateOnly": True or False, # An option to validate, but not actually execute, a request, and provide the same response.
+}
+
+  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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/spanner_v1.projects.instances.backupOperations.html b/docs/dyn/spanner_v1.projects.instances.backupOperations.html index 8b2e915fddc..d9b1bd6bf69 100644 --- a/docs/dyn/spanner_v1.projects.instances.backupOperations.html +++ b/docs/dyn/spanner_v1.projects.instances.backupOperations.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. The instance of the backup operations. Values are of the form `projects//instances/`. (required) - filter: string, An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string "prod". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string "howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test) AND` \ `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string "test". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.database:test_db)) OR` \ `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \ `(metadata.source_backup:test_bkp)) AND` \ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string "test_db" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string "test_bkp" * The operation resulted in an error. + filter: string, An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string "prod". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string "howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. pageSize: integer, Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListBackupOperationsResponse to the same `parent` and with the same `filter`. x__xgafv: string, V1 error format. diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html index 60989e7409b..380fbf82c36 100644 --- a/docs/dyn/spanner_v1.projects.instances.backups.html +++ b/docs/dyn/spanner_v1.projects.instances.backups.html @@ -339,7 +339,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -518,7 +518,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -546,7 +546,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html index 903d6d23b42..f3f5dae98e4 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.html @@ -306,7 +306,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -661,7 +661,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -689,7 +689,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html index 615f5df113b..ce23072ad32 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html @@ -193,6 +193,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "requestOptions": { # Common request options for various APIs. # Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. @@ -324,6 +325,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "transactionId": "A String", # Commit a previously-started transaction. @@ -448,6 +450,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -463,6 +466,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, }, @@ -600,6 +604,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -615,6 +620,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, }, @@ -739,6 +745,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -754,6 +761,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, }, @@ -941,6 +949,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -956,6 +965,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, }, @@ -1038,6 +1048,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1053,6 +1064,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, }, @@ -1139,6 +1151,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1154,6 +1167,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, }, @@ -1315,6 +1329,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1330,6 +1345,7 @@

Method Details

"strong": True or False, # Read at a timestamp where all previously committed transactions are visible. }, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. + "readLockMode": "A String", # Read lock mode for the transaction. }, }, }, diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html index 0d337b76658..7b1e651ad6e 100644 --- a/docs/dyn/spanner_v1.projects.instances.html +++ b/docs/dyn/spanner_v1.projects.instances.html @@ -288,7 +288,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -446,7 +446,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. @@ -474,7 +474,7 @@

Method Details

"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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. diff --git a/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html b/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html index 515706245ab..4c6fe108f38 100644 --- a/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html +++ b/docs/dyn/videointelligence_v1.operations.projects.locations.operations.html @@ -101,7 +101,7 @@

Method Details

Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
@@ -124,7 +124,7 @@

Method Details

Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
diff --git a/docs/dyn/videointelligence_v1.projects.locations.operations.html b/docs/dyn/videointelligence_v1.projects.locations.operations.html index 7541913055a..6140a960542 100644 --- a/docs/dyn/videointelligence_v1.projects.locations.operations.html +++ b/docs/dyn/videointelligence_v1.projects.locations.operations.html @@ -113,7 +113,7 @@

Method Details

Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
@@ -136,7 +136,7 @@

Method Details

Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 1e7595ba74e..dbaebc56fdc 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -84,6 +84,11 @@

Instance Methods

Returns the cutoverJobs Resource.

+

+ replicationCycles() +

+

Returns the replicationCycles Resource.

+

close()

Close httplib2 connections.

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 45e22bfa46e..c913ed1d017 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -275,11 +275,22 @@

Method Details

{ # CutoverStep holds information about the cutover step progress. "endTime": "A String", # The time the step has ended. "finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -303,11 +314,22 @@

Method Details

"preparingVmDisks": { # PreparingVMDisksStep contains specific step details. # Preparing VM disks step. }, "previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -558,11 +580,22 @@

Method Details

{ # CutoverStep holds information about the cutover step progress. "endTime": "A String", # The time the step has ended. "finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -586,11 +619,22 @@

Method Details

"preparingVmDisks": { # PreparingVMDisksStep contains specific step details. # Preparing VM disks step. }, "previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -817,11 +861,22 @@

Method Details

{ # CutoverStep holds information about the cutover step progress. "endTime": "A String", # The time the step has ended. "finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -845,11 +900,22 @@

Method Details

"preparingVmDisks": { # PreparingVMDisksStep contains specific step details. # Preparing VM disks step. }, "previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index a98413e34b1..e8e32ff11c5 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -84,6 +84,11 @@

Instance Methods

Returns the cutoverJobs Resource.

+

+ replicationCycles() +

+

Returns the replicationCycles Resource.

+

close()

Close httplib2 connections.

@@ -240,11 +245,22 @@

Method Details

}, "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -602,11 +618,22 @@

Method Details

{ # CutoverStep holds information about the cutover step progress. "endTime": "A String", # The time the step has ended. "finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -630,11 +657,22 @@

Method Details

"preparingVmDisks": { # PreparingVMDisksStep contains specific step details. # Preparing VM disks step. }, "previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -1006,11 +1044,22 @@

Method Details

}, "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -1368,11 +1417,22 @@

Method Details

{ # CutoverStep holds information about the cutover step progress. "endTime": "A String", # The time the step has ended. "finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -1396,11 +1456,22 @@

Method Details

"preparingVmDisks": { # PreparingVMDisksStep contains specific step details. # Preparing VM disks step. }, "previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -1672,11 +1743,22 @@

Method Details

}, "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -2034,11 +2116,22 @@

Method Details

{ # CutoverStep holds information about the cutover step progress. "endTime": "A String", # The time the step has ended. "finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -2062,11 +2155,22 @@

Method Details

"preparingVmDisks": { # PreparingVMDisksStep contains specific step details. # Preparing VM disks step. }, "previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -2342,11 +2446,22 @@

Method Details

}, "createTime": "A String", # Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). "currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. The percentage progress of the current running replication cycle. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -2704,11 +2819,22 @@

Method Details

{ # CutoverStep holds information about the cutover step progress. "endTime": "A String", # The time the step has ended. "finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -2732,11 +2858,22 @@

Method Details

"preparingVmDisks": { # PreparingVMDisksStep contains specific step details. # Preparing VM disks step. }, "previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html index b628e78cc8f..d0f8bbd5581 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html @@ -107,11 +107,22 @@

Method Details

An object of the form: { # ReplicationCycle contains information about the current replication cycle status. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. @@ -154,11 +165,22 @@

Method Details

"nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "replicationCycles": [ # Output only. The list of replication cycles response. { # ReplicationCycle contains information about the current replication cycle status. + "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. + "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). # Provides details on the state of the cycle in case of an error. + "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. + }, "name": "A String", # The identifier of the ReplicationCycle. "progress": 42, # The current progress in percentage of this cycle. "progressPercent": 42, # The current progress in percentage of this cycle. "startTime": "A String", # The time the replication cycle has started. + "state": "A String", # State of the MigratingVm. "steps": [ # The cycle's steps list representing its progress. { # CycleStep holds information about a step progress. "endTime": "A String", # The time the cycle step has ended. diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index 54b9ed75066..6355761e795 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": { diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 9cab27bf494..8f6f5b31166 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20220904", + "revision": "20220914", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json index 5e30cefa243..67b188c3659 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json @@ -609,7 +609,7 @@ } } }, - "revision": "20220904", + "revision": "20220914", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index 97b54cc0c2a..3b62629d51f 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -595,7 +595,7 @@ "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", + "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", "format": "int32", "location": "query", "type": "integer" @@ -902,7 +902,7 @@ ] }, "pause": { - "description": "Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.", + "description": "Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.", "flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.finalizedProposals.pause", @@ -936,7 +936,7 @@ ] }, "resume": { - "description": "Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.", + "description": "Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.", "flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.finalizedProposals.resume", @@ -2568,7 +2568,7 @@ } } }, - "revision": "20220912", + "revision": "20220917", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { @@ -2621,7 +2621,7 @@ "Ad slot with size specified by height and width in pixels.", "Special size to describe an interstitial ad slot.", "Native (mobile) ads rendered by the publisher.", - "Fluid size (i.e., responsive size) can be resized automatically with the change of outside environment." + "Fluid size (for example, responsive size) can be resized automatically with the change of outside environment." ], "type": "string" }, @@ -2907,7 +2907,7 @@ "type": "object" }, "ClientUser": { - "description": "A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.", + "description": "A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.", "id": "ClientUser", "properties": { "clientAccountId": { @@ -3064,7 +3064,7 @@ "type": "string" }, "apiUpdateTime": { - "description": "Output only. The last update timestamp of the creative via API.", + "description": "Output only. The last update timestamp of the creative through the API.", "format": "google-datetime", "type": "string" }, @@ -3293,7 +3293,7 @@ "type": "array" }, "servingRestrictions": { - "description": "Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).", + "description": "Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction).", "items": { "$ref": "ServingRestriction" }, @@ -3626,7 +3626,7 @@ "type": "string" }, "availableStartTime": { - "description": "Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.", + "description": "Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.", "format": "google-datetime", "type": "string" }, @@ -3666,7 +3666,7 @@ }, "creativeRestrictions": { "$ref": "CreativeRestrictions", - "description": "Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.", + "description": "Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.", "readOnly": true }, "creativeSafeFrameCompatibility": { @@ -3841,7 +3841,7 @@ "type": "object" }, "DealTerms": { - "description": "The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher.", + "description": "The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher.", "id": "DealTerms", "properties": { "brandingType": { @@ -4170,7 +4170,7 @@ "type": "object" }, "FilterSet": { - "description": "A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., \"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)\".", + "description": "A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, \"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)\".", "id": "FilterSet", "properties": { "absoluteDateRange": { @@ -4193,11 +4193,11 @@ "type": "array" }, "creativeId": { - "description": "The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.", + "description": "The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.", "type": "string" }, "dealId": { - "description": "The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.", + "description": "The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.", "format": "int64", "type": "string" }, @@ -4226,9 +4226,9 @@ ], "enumDescriptions": [ "A placeholder for an undefined format; indicates that no format filter will be applied.", - "The ad impression is a native ad, and display (i.e., image) format.", + "The ad impression is a native ad, and display (for example, image) format.", "The ad impression is a native ad, and video format.", - "The ad impression is not a native ad, and display (i.e., image) format.", + "The ad impression is not a native ad, and display (for example, image) format.", "The ad impression is not a native ad, and video format." ], "type": "string" @@ -4245,9 +4245,9 @@ ], "enumDescriptions": [ "A placeholder for an undefined format; indicates that no format filter will be applied.", - "The ad impression is a native ad, and display (i.e., image) format.", + "The ad impression is a native ad, and display (for example, image) format.", "The ad impression is a native ad, and video format.", - "The ad impression is not a native ad, and display (i.e., image) format.", + "The ad impression is not a native ad, and display (for example, image) format.", "The ad impression is not a native ad, and video format." ], "type": "string" @@ -4259,7 +4259,7 @@ "type": "string" }, "platforms": { - "description": "The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).", + "description": "The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms).", "items": { "enum": [ "PLATFORM_UNSPECIFIED", @@ -4293,7 +4293,7 @@ "description": "A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone." }, "sellerNetworkIds": { - "description": "For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.", + "description": "For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.", "items": { "format": "int32", "type": "integer" @@ -4301,7 +4301,7 @@ "type": "array" }, "timeSeriesGranularity": { - "description": "The granularity of time intervals if a time series breakdown is desired; optional.", + "description": "The granularity of time intervals if a time series breakdown is preferred; optional.", "enum": [ "TIME_SERIES_GRANULARITY_UNSPECIFIED", "HOURLY", @@ -4337,7 +4337,7 @@ "type": "object" }, "FilteredBidDetailRow": { - "description": "The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail.", + "description": "The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (for example, creative status), that have the specified detail.", "id": "FilteredBidDetailRow", "properties": { "bidCount": { @@ -4817,7 +4817,7 @@ "id": "ListFilteredBidsResponse", "properties": { "creativeStatusRows": { - "description": "List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status).", + "description": "List of rows, with counts of filtered bids aggregated by filtering reason (for example, creative status).", "items": { "$ref": "CreativeStatusRow" }, @@ -4853,7 +4853,7 @@ "id": "ListLosingBidsResponse", "properties": { "creativeStatusRows": { - "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status).", + "description": "List of rows, with counts of losing bids aggregated by loss reason (for example, creative status).", "items": { "$ref": "CreativeStatusRow" }, @@ -4943,7 +4943,7 @@ "id": "LocationContext", "properties": { "geoCriteriaIds": { - "description": "IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.", + "description": "IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.", "items": { "format": "int32", "type": "integer" @@ -4967,11 +4967,11 @@ }, "placementTargeting": { "$ref": "PlacementTargeting", - "description": "Placement targeting information, e.g., URL, mobile applications." + "description": "Placement targeting information, for example, URL, mobile applications." }, "technologyTargeting": { "$ref": "TechnologyTargeting", - "description": "Technology targeting information, e.g., operating system, device category." + "description": "Technology targeting information, for example, operating system, device category." }, "videoTargeting": { "$ref": "VideoTargeting", @@ -4981,7 +4981,7 @@ "type": "object" }, "MetricValue": { - "description": "A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled).", + "description": "A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (for example, when sampled).", "id": "MetricValue", "properties": { "value": { @@ -4990,7 +4990,7 @@ "type": "string" }, "variance": { - "description": "The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value", + "description": "The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value", "format": "int64", "type": "string" } @@ -5242,7 +5242,7 @@ "type": "object" }, "PlacementTargeting": { - "description": "Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", + "description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", "id": "PlacementTargeting", "properties": { "mobileApplicationTargeting": { @@ -5339,7 +5339,7 @@ "type": "object" }, "Product": { - "description": "A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.", + "description": "A product is a segment of inventory that a seller wants to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.", "id": "Product", "properties": { "availableEndTime": { @@ -5722,16 +5722,16 @@ "type": "object" }, "RelativeDateRange": { - "description": "A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30", + "description": "A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30", "id": "RelativeDateRange", "properties": { "durationDays": { - "description": "The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.", + "description": "The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7.", "format": "int32", "type": "integer" }, "offsetDays": { - "description": "The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.", + "description": "The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0.", "format": "int32", "type": "integer" } @@ -5860,7 +5860,7 @@ "type": "object" }, "ServingRestriction": { - "description": "Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).", + "description": "Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS versus HTTP request, or the type of auction).", "id": "ServingRestriction", "properties": { "contexts": { @@ -5875,7 +5875,7 @@ "description": "Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method." }, "disapprovalReasons": { - "description": "Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.", + "description": "Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead.", "items": { "$ref": "Disapproval" }, @@ -6034,7 +6034,7 @@ "type": "object" }, "UrlTargeting": { - "description": "Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.", + "description": "Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.", "id": "UrlTargeting", "properties": { "excludedUrls": { diff --git a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json index 7d7f4e7f5c0..e403a31c9ea 100644 --- a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json @@ -272,7 +272,7 @@ } } }, - "revision": "20220905", + "revision": "20220913", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index b9db83f21f3..63e7608aa3e 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4405,7 +4405,7 @@ } } }, - "revision": "20220905", + "revision": "20220913", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5799,7 +5799,7 @@ "DATA_LOSS" ], "enumDescriptions": [ - "Not an error; returned on success HTTP Mapping: 200 OK", + "Not an error; returned on success. HTTP Mapping: 200 OK", "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index f37140e3e63..49f5c355121 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -623,7 +623,7 @@ } } }, - "revision": "20220905", + "revision": "20220913", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json index 7ff0a9c4eb6..fe2e7a65788 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -321,7 +321,7 @@ } } }, - "revision": "20220908", + "revision": "20220917", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index 601e1fb8eca..22ffb655394 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -359,7 +359,7 @@ } } }, - "revision": "20220908", + "revision": "20220917", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index 2e52f198bab..dfdafabf167 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1675,7 +1675,7 @@ } } }, - "revision": "20220910", + "revision": "20220915", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index c471c3de0ed..9431a96784e 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20220904", + "revision": "20220912", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AccountSuspensionDetails": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 01cc79b8579..2f4388218ee 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -2802,7 +2802,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index 53287a4ff9b..34516ae9bfe 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -313,7 +313,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json new file mode 100644 index 00000000000..3db41050609 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -0,0 +1,1256 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/bigquery": { + "description": "View and manage your data in Google BigQuery and see the email address for your Google Account" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://analyticshub.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Analytics Hub", + "description": "Exchange data and analytics assets securely and efficiently.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "analyticshub:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://analyticshub.mtls.googleapis.com/", + "name": "analyticshub", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "organizations": { + "resources": { + "locations": { + "resources": { + "dataExchanges": { + "methods": { + "list": { + "description": "Lists all data exchanges from projects in a given organization and location.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dataExchanges", + "httpMethod": "GET", + "id": "analyticshub.organizations.locations.dataExchanges.list", + "parameterOrder": [ + "organization" + ], + "parameters": { + "organization": { + "description": "Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+organization}/dataExchanges", + "response": { + "$ref": "ListOrgDataExchangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "projects": { + "resources": { + "locations": { + "resources": { + "dataExchanges": { + "methods": { + "create": { + "description": "Creates a new data exchange.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "dataExchangeId": { + "description": "Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dataExchanges", + "request": { + "$ref": "DataExchange" + }, + "response": { + "$ref": "DataExchange" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an existing data exchange.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}", + "httpMethod": "DELETE", + "id": "analyticshub.projects.locations.dataExchanges.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a data exchange.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}", + "httpMethod": "GET", + "id": "analyticshub.projects.locations.dataExchanges.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "DataExchange" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the IAM policy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:getIamPolicy", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all data exchanges in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges", + "httpMethod": "GET", + "id": "analyticshub.projects.locations.dataExchanges.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dataExchanges", + "response": { + "$ref": "ListDataExchangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing data exchange.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}", + "httpMethod": "PATCH", + "id": "analyticshub.projects.locations.dataExchanges.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "DataExchange" + }, + "response": { + "$ref": "DataExchange" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the IAM policy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:setIamPolicy", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.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/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns the permissions that a caller has.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:testIamPermissions", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.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/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "listings": { + "methods": { + "create": { + "description": "Creates a new listing.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.listings.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "listingId": { + "description": "Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/listings", + "request": { + "$ref": "Listing" + }, + "response": { + "$ref": "Listing" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a listing.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}", + "httpMethod": "DELETE", + "id": "analyticshub.projects.locations.dataExchanges.listings.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a listing.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}", + "httpMethod": "GET", + "id": "analyticshub.projects.locations.dataExchanges.listings.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Listing" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the IAM policy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:getIamPolicy", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.listings.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all listings in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings", + "httpMethod": "GET", + "id": "analyticshub.projects.locations.dataExchanges.listings.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/listings", + "response": { + "$ref": "ListListingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing listing.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}", + "httpMethod": "PATCH", + "id": "analyticshub.projects.locations.dataExchanges.listings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask specifies the fields to update in the listing resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Listing" + }, + "response": { + "$ref": "Listing" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the IAM policy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:setIamPolicy", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.listings.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/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "subscribe": { + "description": "Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:subscribe", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.listings.subscribe", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:subscribe", + "request": { + "$ref": "SubscribeListingRequest" + }, + "response": { + "$ref": "SubscribeListingResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns the permissions that a caller has.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:testIamPermissions", + "httpMethod": "POST", + "id": "analyticshub.projects.locations.dataExchanges.listings.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/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20220914", + "rootUrl": "https://analyticshub.googleapis.com/", + "schemas": { + "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", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "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.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "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.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "BigQueryDatasetSource": { + "description": "A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset.", + "id": "BigQueryDatasetSource", + "properties": { + "dataset": { + "description": "Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "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)." + }, + "members": { + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "DataExchange": { + "description": "A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.", + "id": "DataExchange", + "properties": { + "description": { + "description": "Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.", + "type": "string" + }, + "displayName": { + "description": "Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.", + "type": "string" + }, + "documentation": { + "description": "Optional. Documentation describing the data exchange.", + "type": "string" + }, + "icon": { + "description": "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.", + "format": "byte", + "type": "string" + }, + "listingCount": { + "description": "Output only. Number of listings contained in the data exchange.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "readOnly": true, + "type": "string" + }, + "primaryContact": { + "description": "Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "DataProvider": { + "description": "Contains details of the data provider.", + "id": "DataProvider", + "properties": { + "name": { + "description": "Optional. Name of the data provider.", + "type": "string" + }, + "primaryContact": { + "description": "Optional. Email or URL of the data provider. Max Length: 1000 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationDataset": { + "description": "Defines the destination bigquery dataset.", + "id": "DestinationDataset", + "properties": { + "datasetReference": { + "$ref": "DestinationDatasetReference", + "description": "Required. A reference that identifies the destination dataset." + }, + "description": { + "description": "Optional. A user-friendly description of the dataset.", + "type": "string" + }, + "friendlyName": { + "description": "Optional. A descriptive name for the dataset.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.", + "type": "object" + }, + "location": { + "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationDatasetReference": { + "description": "Contains the reference that identifies a destination bigquery dataset.", + "id": "DestinationDatasetReference", + "properties": { + "datasetId": { + "description": "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.", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the project containing this dataset.", + "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", + "properties": {}, + "type": "object" + }, + "Expr": { + "description": "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.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "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.", + "type": "string" + } + }, + "type": "object" + }, + "GetIamPolicyRequest": { + "description": "Request message for `GetIamPolicy` method.", + "id": "GetIamPolicyRequest", + "properties": { + "options": { + "$ref": "GetPolicyOptions", + "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." + } + }, + "type": "object" + }, + "GetPolicyOptions": { + "description": "Encapsulates settings provided to GetIamPolicy.", + "id": "GetPolicyOptions", + "properties": { + "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", + "type": "integer" + } + }, + "type": "object" + }, + "ListDataExchangesResponse": { + "description": "Message for response to the list of data exchanges.", + "id": "ListDataExchangesResponse", + "properties": { + "dataExchanges": { + "description": "The list of data exchanges.", + "items": { + "$ref": "DataExchange" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListListingsResponse": { + "description": "Message for response to the list of Listings.", + "id": "ListListingsResponse", + "properties": { + "listings": { + "description": "The list of Listing.", + "items": { + "$ref": "Listing" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListOrgDataExchangesResponse": { + "description": "Message for response to listing data exchanges in an organization and location.", + "id": "ListOrgDataExchangesResponse", + "properties": { + "dataExchanges": { + "description": "The list of data exchanges.", + "items": { + "$ref": "DataExchange" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "Listing": { + "description": "A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.", + "id": "Listing", + "properties": { + "bigqueryDataset": { + "$ref": "BigQueryDatasetSource", + "description": "Required. Shared dataset i.e. BigQuery dataset source." + }, + "categories": { + "description": "Optional. Categories of the listing. Up to two categories are allowed.", + "items": { + "enum": [ + "CATEGORY_UNSPECIFIED", + "CATEGORY_OTHERS", + "CATEGORY_ADVERTISING_AND_MARKETING", + "CATEGORY_COMMERCE", + "CATEGORY_CLIMATE_AND_ENVIRONMENT", + "CATEGORY_DEMOGRAPHICS", + "CATEGORY_ECONOMICS", + "CATEGORY_EDUCATION", + "CATEGORY_ENERGY", + "CATEGORY_FINANCIAL", + "CATEGORY_GAMING", + "CATEGORY_GEOSPATIAL", + "CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE", + "CATEGORY_MEDIA", + "CATEGORY_PUBLIC_SECTOR", + "CATEGORY_RETAIL", + "CATEGORY_SPORTS", + "CATEGORY_SCIENCE_AND_RESEARCH", + "CATEGORY_TRANSPORTATION_AND_LOGISTICS", + "CATEGORY_TRAVEL_AND_TOURISM" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "dataProvider": { + "$ref": "DataProvider", + "description": "Optional. Details of the data provider who owns the source data." + }, + "description": { + "description": "Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.", + "type": "string" + }, + "displayName": { + "description": "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.", + "type": "string" + }, + "documentation": { + "description": "Optional. Documentation describing the listing.", + "type": "string" + }, + "icon": { + "description": "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.", + "format": "byte", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", + "readOnly": true, + "type": "string" + }, + "primaryContact": { + "description": "Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.", + "type": "string" + }, + "publisher": { + "$ref": "Publisher", + "description": "Optional. Details of the publisher who owns the listing and who can share the source data." + }, + "requestAccess": { + "description": "Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.", + "type": "string" + }, + "state": { + "description": "Output only. Current state of the listing.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Subscribable state. Users with dataexchange.listings.subscribe permission can subscribe to this listing." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "cancelRequested": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "statusDetail": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Policy": { + "description": "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/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "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`.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`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.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Publisher": { + "description": "Contains details of the listing publisher.", + "id": "Publisher", + "properties": { + "name": { + "description": "Optional. Name of the listing publisher.", + "type": "string" + }, + "primaryContact": { + "description": "Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "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." + }, + "updateMask": { + "description": "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\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "SubscribeListingRequest": { + "description": "Message for subscribing to a listing.", + "id": "SubscribeListingRequest", + "properties": { + "destinationDataset": { + "$ref": "DestinationDataset", + "description": "BigQuery destination dataset to create for the subscriber." + } + }, + "type": "object" + }, + "SubscribeListingResponse": { + "description": "Message for response when you subscribe to a listing.", + "id": "SubscribeListingResponse", + "properties": {}, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "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).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Analytics Hub API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index e0fc6fb86d0..120962eb1af 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -160,76 +160,6 @@ "projects": { "resources": { "locations": { - "methods": { - "get": { - "description": "Gets information about a location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", - "httpMethod": "GET", - "id": "analyticshub.projects.locations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name for the location.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Location" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists information about the supported locations for this service.", - "flatPath": "v1beta1/projects/{projectsId}/locations", - "httpMethod": "GET", - "id": "analyticshub.projects.locations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "name": { - "description": "The resource that owns the locations collection, if applicable.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The maximum number of results to return. If not set, the service selects a default.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}/locations", - "response": { - "$ref": "ListLocationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "dataExchanges": { "methods": { @@ -765,7 +695,7 @@ } } }, - "revision": "20220902", + "revision": "20220914", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1036,24 +966,6 @@ }, "type": "object" }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "id": "ListLocationsResponse", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "items": { - "$ref": "Location" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "type": "object" - }, "ListOrgDataExchangesResponse": { "description": "Message for response to listing data exchanges in an organization and location.", "id": "ListOrgDataExchangesResponse", @@ -1185,40 +1097,6 @@ }, "type": "object" }, - "Location": { - "description": "A resource that represents Google Cloud Platform location.", - "id": "Location", - "properties": { - "displayName": { - "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object" - }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", - "type": "string" - } - }, - "type": "object" - }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index 931c9e66d84..99d4b95351b 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -825,7 +825,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index ac5c1b0a82f..9b764a2107f 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -700,7 +700,7 @@ "entitlements": { "methods": { "delete": { - "description": "Removes an entitlement to an app for a user.", + "description": "Removes an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}", "httpMethod": "DELETE", "id": "androidenterprise.entitlements.delete", @@ -735,7 +735,7 @@ ] }, "get": { - "description": "Retrieves details of an entitlement.", + "description": "Retrieves details of an entitlement. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}", "httpMethod": "GET", "id": "androidenterprise.entitlements.get", @@ -773,7 +773,7 @@ ] }, "list": { - "description": "Lists all entitlements for the specified user. Only the ID is set.", + "description": "Lists all entitlements for the specified user. Only the ID is set. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements", "httpMethod": "GET", "id": "androidenterprise.entitlements.list", @@ -804,7 +804,7 @@ ] }, "update": { - "description": "Adds or updates an entitlement to an app for a user.", + "description": "Adds or updates an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}", "httpMethod": "PUT", "id": "androidenterprise.entitlements.update", @@ -854,7 +854,7 @@ "grouplicenses": { "methods": { "get": { - "description": "Retrieves details of an enterprise's group license for a product.", + "description": "Retrieves details of an enterprise's group license for a product. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}", "httpMethod": "GET", "id": "androidenterprise.grouplicenses.get", @@ -885,7 +885,7 @@ ] }, "list": { - "description": "Retrieves IDs of all products for which the enterprise has a group license.", + "description": "Retrieves IDs of all products for which the enterprise has a group license. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses", "httpMethod": "GET", "id": "androidenterprise.grouplicenses.list", @@ -913,7 +913,7 @@ "grouplicenseusers": { "methods": { "list": { - "description": "Retrieves the IDs of the users who have been granted entitlements under the license.", + "description": "Retrieves the IDs of the users who have been granted entitlements under the license. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users", "httpMethod": "GET", "id": "androidenterprise.grouplicenseusers.list", @@ -1519,7 +1519,7 @@ "products": { "methods": { "approve": { - "description": " Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. ", + "description": " Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. ", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/approve", "httpMethod": "POST", "id": "androidenterprise.products.approve", @@ -1550,7 +1550,7 @@ ] }, "generateApprovalUrl": { - "description": "Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.", + "description": "Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. ", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl", "httpMethod": "POST", "id": "androidenterprise.products.generateApprovalUrl", @@ -1689,7 +1689,7 @@ ] }, "list": { - "description": "Finds approved products that match a query, or all approved products if there is no query.", + "description": "Finds approved products that match a query, or all approved products if there is no query. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. ", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products", "httpMethod": "GET", "id": "androidenterprise.products.list", @@ -1739,7 +1739,7 @@ ] }, "unapprove": { - "description": "Unapproves the specified product (and the relevant app permissions, if any)", + "description": "Unapproves the specified product (and the relevant app permissions, if any) **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/unapprove", "httpMethod": "POST", "id": "androidenterprise.products.unapprove", @@ -2275,7 +2275,7 @@ ] }, "getAvailableProductSet": { - "description": "Retrieves the set of products a user is entitled to access.", + "description": "Retrieves the set of products a user is entitled to access. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet", "httpMethod": "GET", "id": "androidenterprise.users.getAvailableProductSet", @@ -2392,7 +2392,7 @@ ] }, "setAvailableProductSet": { - "description": "Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.", + "description": "Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet", "httpMethod": "PUT", "id": "androidenterprise.users.setAvailableProductSet", @@ -2610,7 +2610,7 @@ } } }, - "revision": "20220908", + "revision": "20220913", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 742f1c461bf..bec8aa6ad0a 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1065,7 +1065,7 @@ } } }, - "revision": "20220829", + "revision": "20220912", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -4579,7 +4579,7 @@ "type": "array" }, "shareLocationDisabled": { - "description": "Whether location sharing is disabled.", + "description": "Whether location sharing is disabled. share_location_disabled is supported for both fully managed devices and personally owned work profiles.", "type": "boolean" }, "shortSupportMessage": { @@ -4659,7 +4659,7 @@ "type": "boolean" }, "wifiConfigDisabled": { - "description": "Whether configuring Wi-Fi access points is disabled.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled).", + "description": "Whether configuring Wi-Fi access points is disabled. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled).", "type": "boolean" }, "wifiConfigsLockdownEnabled": { diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 4415f75eb62..2fac3c8d587 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -3920,7 +3920,7 @@ } } }, - "revision": "20220907", + "revision": "20220915", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "AcquisitionTargetingRule": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index ab214f713b2..c45a5352b95 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { @@ -1336,7 +1336,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index af64fe2185d..321ea716d0e 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -1352,7 +1352,7 @@ "entries": { "methods": { "create": { - "description": "Creates key value entries in a key value map scoped to an organization, environment, or API proxy.", + "description": "Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries", "httpMethod": "POST", "id": "apigee.organizations.apis.keyvaluemaps.entries.create", @@ -1380,7 +1380,7 @@ ] }, "delete": { - "description": "Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.", + "description": "Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}", "httpMethod": "DELETE", "id": "apigee.organizations.apis.keyvaluemaps.entries.delete", @@ -1405,7 +1405,7 @@ ] }, "get": { - "description": "Get the Key value entry value for org, env or apis scoped Key value map.", + "description": "Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}", "httpMethod": "GET", "id": "apigee.organizations.apis.keyvaluemaps.entries.get", @@ -1430,7 +1430,7 @@ ] }, "list": { - "description": "Lists key value entries for key values maps scoped to an organization, environment, or API proxy.", + "description": "Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries", "httpMethod": "GET", "id": "apigee.organizations.apis.keyvaluemaps.entries.list", @@ -5094,7 +5094,7 @@ "entries": { "methods": { "create": { - "description": "Creates key value entries in a key value map scoped to an organization, environment, or API proxy.", + "description": "Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries", "httpMethod": "POST", "id": "apigee.organizations.environments.keyvaluemaps.entries.create", @@ -5122,7 +5122,7 @@ ] }, "delete": { - "description": "Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.", + "description": "Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}", "httpMethod": "DELETE", "id": "apigee.organizations.environments.keyvaluemaps.entries.delete", @@ -5147,7 +5147,7 @@ ] }, "get": { - "description": "Get the Key value entry value for org, env or apis scoped Key value map.", + "description": "Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}", "httpMethod": "GET", "id": "apigee.organizations.environments.keyvaluemaps.entries.get", @@ -5172,7 +5172,7 @@ ] }, "list": { - "description": "Lists key value entries for key values maps scoped to an organization, environment, or API proxy.", + "description": "Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries", "httpMethod": "GET", "id": "apigee.organizations.environments.keyvaluemaps.entries.list", @@ -7540,7 +7540,7 @@ "entries": { "methods": { "create": { - "description": "Creates key value entries in a key value map scoped to an organization, environment, or API proxy.", + "description": "Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries", "httpMethod": "POST", "id": "apigee.organizations.keyvaluemaps.entries.create", @@ -7568,7 +7568,7 @@ ] }, "delete": { - "description": "Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Note:** After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.", + "description": "Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}", "httpMethod": "DELETE", "id": "apigee.organizations.keyvaluemaps.entries.delete", @@ -7593,7 +7593,7 @@ ] }, "get": { - "description": "Get the Key value entry value for org, env or apis scoped Key value map.", + "description": "Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}", "httpMethod": "GET", "id": "apigee.organizations.keyvaluemaps.entries.get", @@ -7618,7 +7618,7 @@ ] }, "list": { - "description": "Lists key value entries for key values maps scoped to an organization, environment, or API proxy.", + "description": "Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries", "httpMethod": "GET", "id": "apigee.organizations.keyvaluemaps.entries.list", @@ -8609,7 +8609,7 @@ } } }, - "revision": "20220901", + "revision": "20220908", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -11685,7 +11685,7 @@ "type": "object" }, "GoogleCloudApigeeV1KeyValueEntry": { - "description": "Key value map pair where the value represents the data associated with the corresponding key.", + "description": "Key value map pair where the value represents the data associated with the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and higher.", "id": "GoogleCloudApigeeV1KeyValueEntry", "properties": { "name": { @@ -12088,7 +12088,7 @@ "type": "object" }, "GoogleCloudApigeeV1ListKeyValueEntriesResponse": { - "description": "The request structure for listing Key value map keys and its corrresponding values.", + "description": "The request structure for listing key value map keys and its corresponding values.", "id": "GoogleCloudApigeeV1ListKeyValueEntriesResponse", "properties": { "keyValueEntries": { diff --git a/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json b/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json index 17f0a40fed4..98795c39125 100644 --- a/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json @@ -3171,7 +3171,7 @@ } } }, - "revision": "20220831", + "revision": "20220901", "rootUrl": "https://apigeeregistry.googleapis.com/", "schemas": { "Api": { diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index 859b37bcb6f..910c1859cba 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, - "revision": "20220907", + "revision": "20220916", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 139beb5e6bd..4f46c7cc74d 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1595,7 +1595,7 @@ } } }, - "revision": "20220904", + "revision": "20220912", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json index 26da2f38694..8f98ee4e40a 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -887,7 +887,7 @@ } } }, - "revision": "20220904", + "revision": "20220912", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 58dfdb02561..bf70338cec2 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1595,7 +1595,7 @@ } } }, - "revision": "20220904", + "revision": "20220912", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json index a028c7d46f2..06d0d3af4f0 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -586,7 +586,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index aeb6d76e34c..effbd15099b 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -743,6 +743,50 @@ } } }, + "kfpArtifacts": { + "methods": { + "upload": { + "description": "Directly uploads a KFP artifact. The returned Operation will complete once the resource is uploaded. Package, Version, and File resources will be created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will be overwritten.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/kfpArtifacts:create", + "httpMethod": "POST", + "id": "artifactregistry.projects.locations.repositories.kfpArtifacts.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1/{+parent}/kfpArtifacts:create" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "The resource name of the repository where the KFP artifact will be uploaded.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/kfpArtifacts:create", + "request": { + "$ref": "UploadKfpArtifactRequest" + }, + "response": { + "$ref": "UploadKfpArtifactMediaResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true + } + } + }, "mavenArtifacts": { "methods": { "get": { @@ -1413,7 +1457,7 @@ } } }, - "revision": "20220829", + "revision": "20220910", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -1781,6 +1825,22 @@ }, "type": "object" }, + "KfpArtifact": { + "description": "A detailed representation of a GooGet artifact.", + "id": "KfpArtifact", + "properties": { + "name": { + "description": "Output only. Resource name of the KFP artifact. Since users don't directly interact with this resource, the name will be derived from the associated version. For example, when version = \".../versions/sha256:abcdef...\", the name will be \".../kfpArtifacts/sha256:abcdef...\".", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "The version associated with the KFP artifact. Must follow the Semantic Versioning standard.", + "type": "string" + } + }, + "type": "object" + }, "ListDockerImagesResponse": { "description": "The response from listing docker images.", "id": "ListDockerImagesResponse", @@ -2437,6 +2497,41 @@ }, "type": "object" }, + "UploadKfpArtifactMediaResponse": { + "description": "The response to upload an artifact.", + "id": "UploadKfpArtifactMediaResponse", + "properties": { + "operation": { + "$ref": "Operation", + "description": "Operation that will be returned to the user." + } + }, + "type": "object" + }, + "UploadKfpArtifactMetadata": { + "description": "The operation metadata for uploading KFP artifacts.", + "id": "UploadKfpArtifactMetadata", + "properties": {}, + "type": "object" + }, + "UploadKfpArtifactRequest": { + "description": "The request to upload an artifact.", + "id": "UploadKfpArtifactRequest", + "properties": { + "description": { + "description": "Description of the package version.", + "type": "string" + }, + "tags": { + "description": "Tags to be created with the version.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "UploadYumArtifactMediaResponse": { "description": "The response to upload an artifact.", "id": "UploadYumArtifactMediaResponse", diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index cb2657d9959..e35dad435c6 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -929,7 +929,7 @@ } } }, - "revision": "20220829", + "revision": "20220910", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index e5125e5f22e..d50df0962d2 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -1135,7 +1135,7 @@ } } }, - "revision": "20220829", + "revision": "20220910", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 80eccda2115..56a8fc77db3 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -379,7 +379,7 @@ } } }, - "revision": "20220901", + "revision": "20220909", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": { @@ -399,8 +399,7 @@ "HITRUST", "EU_REGIONS_AND_SUPPORT", "CA_REGIONS_AND_SUPPORT", - "ITAR", - "AU_REGIONS_AND_US_SUPPORT" + "ITAR" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -413,8 +412,7 @@ "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", - "International Traffic in Arms Regulations", - "Assured Workloads for Australia Regions and Support controls" + "International Traffic in Arms Regulations" ], "type": "string" }, @@ -500,8 +498,7 @@ "HITRUST", "EU_REGIONS_AND_SUPPORT", "CA_REGIONS_AND_SUPPORT", - "ITAR", - "AU_REGIONS_AND_US_SUPPORT" + "ITAR" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -514,11 +511,18 @@ "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", - "International Traffic in Arms Regulations", - "Assured Workloads for Australia Regions and Support controls" + "International Traffic in Arms Regulations" ], "type": "string" }, + "compliantButDisallowedServices": { + "description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.\"", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "createTime": { "description": "Output only. Immutable. The Workload creation timestamp.", "format": "google-datetime", @@ -733,8 +737,7 @@ "HITRUST", "EU_REGIONS_AND_SUPPORT", "CA_REGIONS_AND_SUPPORT", - "ITAR", - "AU_REGIONS_AND_US_SUPPORT" + "ITAR" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -747,8 +750,7 @@ "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", - "International Traffic in Arms Regulations", - "Assured Workloads for Australia Regions and Support controls" + "International Traffic in Arms Regulations" ], "type": "string" }, @@ -800,8 +802,7 @@ "HITRUST", "EU_REGIONS_AND_SUPPORT", "CA_REGIONS_AND_SUPPORT", - "ITAR", - "AU_REGIONS_AND_US_SUPPORT" + "ITAR" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -814,8 +815,7 @@ "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", - "International Traffic in Arms Regulations", - "Assured Workloads for Australia Regions and Support controls" + "International Traffic in Arms Regulations" ], "type": "string" }, @@ -1097,8 +1097,7 @@ "HITRUST", "EU_REGIONS_AND_SUPPORT", "CA_REGIONS_AND_SUPPORT", - "ITAR", - "AU_REGIONS_AND_US_SUPPORT" + "ITAR" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -1111,8 +1110,7 @@ "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", - "International Traffic in Arms Regulations", - "Assured Workloads for Australia Regions and Support controls" + "International Traffic in Arms Regulations" ], "type": "string" }, @@ -1164,8 +1162,7 @@ "HITRUST", "EU_REGIONS_AND_SUPPORT", "CA_REGIONS_AND_SUPPORT", - "ITAR", - "AU_REGIONS_AND_US_SUPPORT" + "ITAR" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -1178,8 +1175,7 @@ "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", - "International Traffic in Arms Regulations", - "Assured Workloads for Australia Regions and Support controls" + "International Traffic in Arms Regulations" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json new file mode 100644 index 00000000000..6105c46c8e9 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -0,0 +1,2175 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://assuredworkloads.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Assuredworkloads", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "assuredworkloads:v1beta1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://assuredworkloads.mtls.googleapis.com/", + "name": "assuredworkloads", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "organizations": { + "resources": { + "locations": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workloads": { + "methods": { + "create": { + "description": "Creates Assured Workload.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", + "httpMethod": "POST", + "id": "assuredworkloads.organizations.locations.workloads.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "externalId": { + "description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/workloads", + "request": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", + "httpMethod": "DELETE", + "id": "assuredworkloads.organizations.locations.workloads.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets Assured Workload associated with a CRM Node", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1Workload" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Assured Workloads under a CRM Node.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/workloads", + "response": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1ListWorkloadsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", + "httpMethod": "PATCH", + "id": "assuredworkloads.organizations.locations.workloads.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1Workload" + }, + "response": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1Workload" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restrictAllowedResources": { + "description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", + "httpMethod": "POST", + "id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:restrictAllowedResources", + "request": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest" + }, + "response": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "organizations": { + "resources": { + "locations": { + "resources": { + "workloads": { + "methods": { + "analyzeWorkloadMove": { + "description": "Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/organizations/{organizationsId1}/locations/{locationsId1}/workloads/{workloadsId1}:analyzeWorkloadMove", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.organizations.locations.workloads.analyzeWorkloadMove", + "parameterOrder": [ + "source", + "target" + ], + "parameters": { + "project": { + "description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", + "location": "query", + "type": "string" + }, + "source": { + "description": "The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-1\"", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + }, + "target": { + "description": "Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+source}/{+target}:analyzeWorkloadMove", + "response": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1AnalyzeWorkloadMoveResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "violations": { + "methods": { + "get": { + "description": "Retrieves Assured Workload Violation based on ID.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.violations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1Violation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.violations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A custom filter for filtering by the Violations properties.", + "location": "query", + "type": "string" + }, + "interval.endTime": { + "description": "The end of the time window.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "interval.startTime": { + "description": "The start of the time window.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token returned from previous request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/violations", + "response": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1ListViolationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, + "projects": { + "resources": { + "organizations": { + "resources": { + "locations": { + "resources": { + "workloads": { + "methods": { + "analyzeWorkloadMove": { + "description": "Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.", + "flatPath": "v1beta1/projects/{projectsId}/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", + "httpMethod": "GET", + "id": "assuredworkloads.projects.organizations.locations.workloads.analyzeWorkloadMove", + "parameterOrder": [ + "project", + "target" + ], + "parameters": { + "project": { + "description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "source": { + "description": "The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-1\"", + "location": "query", + "type": "string" + }, + "target": { + "description": "Required. The resource ID of the folder-based destination workload. This workload is where the source project will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+project}/{+target}:analyzeWorkloadMove", + "response": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1AnalyzeWorkloadMoveResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20220909", + "rootUrl": "https://assuredworkloads.googleapis.com/", + "schemas": { + "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": { + "description": "Operation metadata to give request details of CreateWorkload.", + "id": "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata", + "properties": { + "complianceRegime": { + "description": "Optional. Compliance controls that should be applied to the resources managed by the workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST", + "EU_REGIONS_AND_SUPPORT", + "CA_REGIONS_AND_SUPPORT", + "ITAR" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls", + "Assured Workloads For EU Regions and Support controls", + "Assured Workloads For Canada Regions and Support controls", + "International Traffic in Arms Regulations" + ], + "type": "string" + }, + "createTime": { + "description": "Optional. Time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the workload.", + "type": "string" + }, + "parent": { + "description": "Optional. The parent of the workload.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1Workload": { + "description": "An Workload object for managing highly regulated workloads of cloud customers.", + "id": "GoogleCloudAssuredworkloadsV1Workload", + "properties": { + "billingAccount": { + "description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.", + "type": "string" + }, + "complianceRegime": { + "description": "Required. Immutable. Compliance Regime associated with this workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST", + "EU_REGIONS_AND_SUPPORT", + "CA_REGIONS_AND_SUPPORT", + "ITAR" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls", + "Assured Workloads For EU Regions and Support controls", + "Assured Workloads For Canada Regions and Support controls", + "International Traffic in Arms Regulations" + ], + "type": "string" + }, + "compliantButDisallowedServices": { + "description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.\"", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. Immutable. The Workload creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", + "type": "string" + }, + "enableSovereignControls": { + "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", + "type": "boolean" + }, + "etag": { + "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", + "type": "string" + }, + "kajEnrollmentState": { + "description": "Output only. Represents the KAJ enrollment state of the given workload.", + "enum": [ + "KAJ_ENROLLMENT_STATE_UNSPECIFIED", + "KAJ_ENROLLMENT_STATE_PENDING", + "KAJ_ENROLLMENT_STATE_COMPLETE" + ], + "enumDescriptions": [ + "Default State for KAJ Enrollment.", + "Pending State for KAJ Enrollment.", + "Complete State for KAJ Enrollment." + ], + "readOnly": true, + "type": "string" + }, + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings", + "description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels applied to the workload.", + "type": "object" + }, + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "type": "string" + }, + "provisionedResourcesParent": { + "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}", + "type": "string" + }, + "resourceSettings": { + "description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings" + }, + "type": "array" + }, + "resources": { + "description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo" + }, + "readOnly": true, + "type": "array" + }, + "saaEnrollmentResponse": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse", + "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings": { + "description": "Settings specific to the Key Management Service.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings", + "properties": { + "nextRotationTime": { + "description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo": { + "description": "Represent the resources that are children of this Workload.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo", + "properties": { + "resourceId": { + "description": "Resource identifier. For a project this represents project_number.", + "format": "int64", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Consumer project. AssuredWorkloads Projects are no longer supported. This field will be ignored only in CreateWorkload requests. ListWorkloads and GetWorkload will continue to provide projects information. Use CONSUMER_FOLDER instead.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings": { + "description": "Represent the custom settings for the resources to be created.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings", + "properties": { + "displayName": { + "description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.", + "type": "string" + }, + "resourceId": { + "description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Consumer project. AssuredWorkloads Projects are no longer supported. This field will be ignored only in CreateWorkload requests. ListWorkloads and GetWorkload will continue to provide projects information. Use CONSUMER_FOLDER instead.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse": { + "description": "Signed Access Approvals (SAA) enrollment response.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse", + "properties": { + "setupErrors": { + "description": "Indicates SAA enrollment setup error if any.", + "items": { + "enum": [ + "SETUP_ERROR_UNSPECIFIED", + "ERROR_INVALID_BASE_SETUP", + "ERROR_MISSING_EXTERNAL_SIGNING_KEY", + "ERROR_NOT_ALL_SERVICES_ENROLLED", + "ERROR_SETUP_CHECK_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Invalid states for all customers, to be redirected to AA UI for additional details.", + "Returned when there is not an EKM key configured.", + "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", + "Returned when exception was encountered during evaluation of other criteria." + ], + "type": "string" + }, + "type": "array" + }, + "setupStatus": { + "description": "Indicates SAA enrollment status of a given workload.", + "enum": [ + "SETUP_STATE_UNSPECIFIED", + "STATUS_PENDING", + "STATUS_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "SAA enrollment pending.", + "SAA enrollment comopleted." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata": { + "description": "Operation metadata to give request details of CreateWorkload.", + "id": "GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata", + "properties": { + "complianceRegime": { + "description": "Optional. Compliance controls that should be applied to the resources managed by the workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST", + "EU_REGIONS_AND_SUPPORT", + "CA_REGIONS_AND_SUPPORT", + "ITAR" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls", + "Assured Workloads For EU Regions and Support controls", + "Assured Workloads For Canada Regions and Support controls", + "International Traffic in Arms Regulations" + ], + "type": "string" + }, + "createTime": { + "description": "Optional. Time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the workload.", + "type": "string" + }, + "parent": { + "description": "Optional. The parent of the workload.", + "type": "string" + }, + "resourceSettings": { + "description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest": { + "description": "Request for restricting list of available resources in Workload environment.", + "id": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest", + "properties": { + "restrictionType": { + "description": "Required. The type of restriction for using gcp products in the Workload environment.", + "enum": [ + "RESTRICTION_TYPE_UNSPECIFIED", + "ALLOW_ALL_GCP_RESOURCES", + "ALLOW_COMPLIANT_RESOURCES" + ], + "enumDescriptions": [ + "Unknown restriction type.", + "Allow the use all of all gcp products, irrespective of the compliance posture. This effectively removes gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder.", + "Based on Workload's compliance regime, allowed list changes. See - https://cloud.google.com/assured-workloads/docs/supported-products for the list of supported resources." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse": { + "description": "Response for restricting the list of allowed resources.", + "id": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1Workload": { + "description": "An Workload object for managing highly regulated workloads of cloud customers.", + "id": "GoogleCloudAssuredworkloadsV1beta1Workload", + "properties": { + "billingAccount": { + "description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.", + "type": "string" + }, + "cjisSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings", + "description": "Input only. Immutable. Settings specific to resources needed for CJIS." + }, + "complianceRegime": { + "description": "Required. Immutable. Compliance Regime associated with this workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST", + "EU_REGIONS_AND_SUPPORT", + "CA_REGIONS_AND_SUPPORT", + "ITAR" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls", + "Assured Workloads For EU Regions and Support controls", + "Assured Workloads For Canada Regions and Support controls", + "International Traffic in Arms Regulations" + ], + "type": "string" + }, + "compliantButDisallowedServices": { + "description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.\"", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. Immutable. The Workload creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", + "type": "string" + }, + "enableSovereignControls": { + "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", + "type": "boolean" + }, + "etag": { + "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", + "type": "string" + }, + "fedrampHighSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings", + "description": "Input only. Immutable. Settings specific to resources needed for FedRAMP High." + }, + "fedrampModerateSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings", + "description": "Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate." + }, + "il4Settings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings", + "description": "Input only. Immutable. Settings specific to resources needed for IL4." + }, + "kajEnrollmentState": { + "description": "Output only. Represents the KAJ enrollment state of the given workload.", + "enum": [ + "KAJ_ENROLLMENT_STATE_UNSPECIFIED", + "KAJ_ENROLLMENT_STATE_PENDING", + "KAJ_ENROLLMENT_STATE_COMPLETE" + ], + "enumDescriptions": [ + "Default State for KAJ Enrollment.", + "Pending State for KAJ Enrollment.", + "Complete State for KAJ Enrollment." + ], + "readOnly": true, + "type": "string" + }, + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels applied to the workload.", + "type": "object" + }, + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "type": "string" + }, + "provisionedResourcesParent": { + "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}", + "type": "string" + }, + "resourceSettings": { + "description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings" + }, + "type": "array" + }, + "resources": { + "description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo" + }, + "readOnly": true, + "type": "array" + }, + "saaEnrollmentResponse": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse", + "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings": { + "description": "Settings specific to resources needed for CJIS.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings": { + "description": "Settings specific to resources needed for FedRAMP High.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings": { + "description": "Settings specific to resources needed for FedRAMP Moderate.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings": { + "description": "Settings specific to resources needed for IL4.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings": { + "description": "Settings specific to the Key Management Service.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "properties": { + "nextRotationTime": { + "description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo": { + "description": "Represent the resources that are children of this Workload.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo", + "properties": { + "resourceId": { + "description": "Resource identifier. For a project this represents project_number.", + "format": "int64", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings": { + "description": "Represent the custom settings for the resources to be created.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings", + "properties": { + "displayName": { + "description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.", + "type": "string" + }, + "resourceId": { + "description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse": { + "description": "Signed Access Approvals (SAA) enrollment response.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse", + "properties": { + "setupErrors": { + "description": "Indicates SAA enrollment setup error if any.", + "items": { + "enum": [ + "SETUP_ERROR_UNSPECIFIED", + "ERROR_INVALID_BASE_SETUP", + "ERROR_MISSING_EXTERNAL_SIGNING_KEY", + "ERROR_NOT_ALL_SERVICES_ENROLLED", + "ERROR_SETUP_CHECK_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Invalid states for all customers, to be redirected to AA UI for additional details.", + "Returned when there is not an EKM key configured.", + "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", + "Returned when exception was encountered during evaluation of other criteria." + ], + "type": "string" + }, + "type": "array" + }, + "setupStatus": { + "description": "Indicates SAA enrollment status of a given workload.", + "enum": [ + "SETUP_STATE_UNSPECIFIED", + "STATUS_PENDING", + "STATUS_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "SAA enrollment pending.", + "SAA enrollment comopleted." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1AnalyzeWorkloadMoveResponse": { + "description": "A response that includes the analysis of the hypothetical resource move.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1AnalyzeWorkloadMoveResponse", + "properties": { + "blockers": { + "description": "A list of blockers that should be addressed before moving the source project or project-based workload to the destination folder-based workload.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1ListViolationsResponse": { + "description": "Response of ListViolations endpoint.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1ListViolationsResponse", + "properties": { + "nextPageToken": { + "description": "The next page token. Returns empty if reached the last page.", + "type": "string" + }, + "violations": { + "description": "List of Violations under a Workload.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1Violation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1ListWorkloadsResponse": { + "description": "Response of ListWorkloads endpoint.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1ListWorkloadsResponse", + "properties": { + "nextPageToken": { + "description": "The next page token. Return empty if reached the last page.", + "type": "string" + }, + "workloads": { + "description": "List of Workloads under a given parent.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1Workload" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1Violation": { + "description": "Workload monitoring Violation.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1Violation", + "properties": { + "auditLogLink": { + "description": "Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}", + "readOnly": true, + "type": "string" + }, + "beginTime": { + "description": "Output only. Time of the event which triggered the Violation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "category": { + "description": "Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}", + "readOnly": true, + "type": "string" + }, + "nonCompliantOrgPolicy": { + "description": "Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}", + "readOnly": true, + "type": "string" + }, + "orgPolicyConstraint": { + "description": "Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.", + "readOnly": true, + "type": "string" + }, + "resolveTime": { + "description": "Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the violation", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "RESOLVED", + "UNRESOLVED", + "EXCEPTION" + ], + "enumDescriptions": [ + "Unspecified state.", + "Violation currently active. ", + "Violation is resolved.", + "Violation is Unresolved", + "Violation is Exception" + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The last time when the Violation record was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1Workload": { + "description": "An Workload object for managing highly regulated workloads of cloud customers.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1Workload", + "properties": { + "billingAccount": { + "description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.", + "type": "string" + }, + "cjisSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadCJISSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for CJIS." + }, + "complianceRegime": { + "description": "Required. Immutable. Compliance Regime associated with this workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST", + "EU_REGIONS_AND_SUPPORT", + "CA_REGIONS_AND_SUPPORT", + "ITAR" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls", + "Assured Workloads For EU Regions and Support controls", + "Assured Workloads For Canada Regions and Support controls", + "International Traffic in Arms Regulations" + ], + "type": "string" + }, + "complianceStatus": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadComplianceStatus", + "description": "Output only. Count of active Violations in the Workload.", + "readOnly": true + }, + "compliantButDisallowedServices": { + "description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.\"", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. Immutable. The Workload creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", + "type": "string" + }, + "enableSovereignControls": { + "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", + "type": "boolean" + }, + "etag": { + "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", + "type": "string" + }, + "fedrampHighSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadFedrampHighSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High." + }, + "fedrampModerateSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadFedrampModerateSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate." + }, + "il4Settings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadIL4Settings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for IL4." + }, + "kajEnrollmentState": { + "description": "Output only. Represents the KAJ enrollment state of the given workload.", + "enum": [ + "KAJ_ENROLLMENT_STATE_UNSPECIFIED", + "KAJ_ENROLLMENT_STATE_PENDING", + "KAJ_ENROLLMENT_STATE_COMPLETE" + ], + "enumDescriptions": [ + "Default State for KAJ Enrollment.", + "Pending State for KAJ Enrollment.", + "Complete State for KAJ Enrollment." + ], + "readOnly": true, + "type": "string" + }, + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadKMSSettings", + "description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels applied to the workload.", + "type": "object" + }, + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "type": "string" + }, + "provisionedResourcesParent": { + "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}", + "type": "string" + }, + "resourceSettings": { + "description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadResourceSettings" + }, + "type": "array" + }, + "resources": { + "description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadResourceInfo" + }, + "readOnly": true, + "type": "array" + }, + "saaEnrollmentResponse": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadSaaEnrollmentResponse", + "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadCJISSettings": { + "description": "Settings specific to resources needed for CJIS.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadCJISSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadComplianceStatus": { + "description": "Represents the Compliance Status of this workload", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadComplianceStatus", + "properties": { + "acknowledgedViolationCount": { + "description": "Count of active Violations which are acknowledged in the Workload.", + "format": "int32", + "type": "integer" + }, + "activeViolationCount": { + "description": "Count of active Violations which haven't been acknowledged.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadFedrampHighSettings": { + "description": "Settings specific to resources needed for FedRAMP High.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadFedrampHighSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadFedrampModerateSettings": { + "description": "Settings specific to resources needed for FedRAMP Moderate.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadFedrampModerateSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadIL4Settings": { + "description": "Settings specific to resources needed for IL4.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadIL4Settings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadKMSSettings": { + "description": "Settings specific to the Key Management Service.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadKMSSettings", + "properties": { + "nextRotationTime": { + "description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadResourceInfo": { + "description": "Represent the resources that are children of this Workload.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadResourceInfo", + "properties": { + "resourceId": { + "description": "Resource identifier. For a project this represents project_number.", + "format": "int64", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadResourceSettings": { + "description": "Represent the custom settings for the resources to be created.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadResourceSettings", + "properties": { + "displayName": { + "description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.", + "type": "string" + }, + "resourceId": { + "description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadSaaEnrollmentResponse": { + "description": "Signed Access Approvals (SAA) enrollment response.", + "id": "GoogleCloudAssuredworkloadsVersioningV1beta1WorkloadSaaEnrollmentResponse", + "properties": { + "setupErrors": { + "description": "Indicates SAA enrollment setup error if any.", + "items": { + "enum": [ + "SETUP_ERROR_UNSPECIFIED", + "ERROR_INVALID_BASE_SETUP", + "ERROR_MISSING_EXTERNAL_SIGNING_KEY", + "ERROR_NOT_ALL_SERVICES_ENROLLED", + "ERROR_SETUP_CHECK_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Invalid states for all customers, to be redirected to AA UI for additional details.", + "Returned when there is not an EKM key configured.", + "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", + "Returned when exception was encountered during evaluation of other criteria." + ], + "type": "string" + }, + "type": "array" + }, + "setupStatus": { + "description": "Indicates SAA enrollment status of a given workload.", + "enum": [ + "SETUP_STATE_UNSPECIFIED", + "STATUS_PENDING", + "STATUS_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "SAA enrollment pending.", + "SAA enrollment comopleted." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata": { + "description": "Operation metadata to give request details of CreateWorkload.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata", + "properties": { + "complianceRegime": { + "description": "Optional. Compliance controls that should be applied to the resources managed by the workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST", + "EU_REGIONS_AND_SUPPORT", + "CA_REGIONS_AND_SUPPORT", + "ITAR" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls", + "Assured Workloads For EU Regions and Support controls", + "Assured Workloads For Canada Regions and Support controls", + "International Traffic in Arms Regulations" + ], + "type": "string" + }, + "createTime": { + "description": "Optional. Time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the workload.", + "type": "string" + }, + "parent": { + "description": "Optional. The parent of the workload.", + "type": "string" + }, + "resourceSettings": { + "description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkload": { + "description": "An Workload object for managing highly regulated workloads of cloud customers.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkload", + "properties": { + "billingAccount": { + "description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.", + "type": "string" + }, + "cjisSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadCJISSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for CJIS." + }, + "complianceRegime": { + "description": "Required. Immutable. Compliance Regime associated with this workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS", + "HIPAA", + "HITRUST", + "EU_REGIONS_AND_SUPPORT", + "CA_REGIONS_AND_SUPPORT", + "ITAR" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls", + "Health Insurance Portability and Accountability Act controls", + "Health Information Trust Alliance controls", + "Assured Workloads For EU Regions and Support controls", + "Assured Workloads For Canada Regions and Support controls", + "International Traffic in Arms Regulations" + ], + "type": "string" + }, + "complianceStatus": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadComplianceStatus", + "description": "Output only. Count of active Violations in the Workload.", + "readOnly": true + }, + "compliantButDisallowedServices": { + "description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.\"", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. Immutable. The Workload creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", + "type": "string" + }, + "enableSovereignControls": { + "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", + "type": "boolean" + }, + "etag": { + "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", + "type": "string" + }, + "fedrampHighSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampHighSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High." + }, + "fedrampModerateSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampModerateSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate." + }, + "il4Settings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadIL4Settings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for IL4." + }, + "kajEnrollmentState": { + "description": "Output only. Represents the KAJ enrollment state of the given workload.", + "enum": [ + "KAJ_ENROLLMENT_STATE_UNSPECIFIED", + "KAJ_ENROLLMENT_STATE_PENDING", + "KAJ_ENROLLMENT_STATE_COMPLETE" + ], + "enumDescriptions": [ + "Default State for KAJ Enrollment.", + "Pending State for KAJ Enrollment.", + "Complete State for KAJ Enrollment." + ], + "readOnly": true, + "type": "string" + }, + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings", + "description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels applied to the workload.", + "type": "object" + }, + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "type": "string" + }, + "provisionedResourcesParent": { + "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}", + "type": "string" + }, + "resourceSettings": { + "description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings" + }, + "type": "array" + }, + "resources": { + "description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceInfo" + }, + "readOnly": true, + "type": "array" + }, + "saaEnrollmentResponse": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse", + "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadCJISSettings": { + "description": "Settings specific to resources needed for CJIS.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadCJISSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadComplianceStatus": { + "description": "Represents the Compliance Status of this workload", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadComplianceStatus", + "properties": { + "acknowledgedViolationCount": { + "description": "Count of active Violations which are acknowledged in the Workload.", + "format": "int32", + "type": "integer" + }, + "activeViolationCount": { + "description": "Count of active Violations which haven't been acknowledged.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampHighSettings": { + "description": "Settings specific to resources needed for FedRAMP High.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampHighSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampModerateSettings": { + "description": "Settings specific to resources needed for FedRAMP Moderate.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampModerateSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadIL4Settings": { + "description": "Settings specific to resources needed for IL4.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadIL4Settings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings", + "description": "Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings": { + "description": "Settings specific to the Key Management Service.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings", + "properties": { + "nextRotationTime": { + "description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceInfo": { + "description": "Represent the resources that are children of this Workload.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceInfo", + "properties": { + "resourceId": { + "description": "Resource identifier. For a project this represents project_number.", + "format": "int64", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings": { + "description": "Represent the custom settings for the resources to be created.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings", + "properties": { + "displayName": { + "description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.", + "type": "string" + }, + "resourceId": { + "description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "CONSUMER_FOLDER", + "ENCRYPTION_KEYS_PROJECT", + "KEYRING" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", + "Consumer Folder.", + "Consumer project containing encryption keys.", + "Keyring resource that hosts encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse": { + "description": "Signed Access Approvals (SAA) enrollment response.", + "id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse", + "properties": { + "setupErrors": { + "description": "Indicates SAA enrollment setup error if any.", + "items": { + "enum": [ + "SETUP_ERROR_UNSPECIFIED", + "ERROR_INVALID_BASE_SETUP", + "ERROR_MISSING_EXTERNAL_SIGNING_KEY", + "ERROR_NOT_ALL_SERVICES_ENROLLED", + "ERROR_SETUP_CHECK_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Invalid states for all customers, to be redirected to AA UI for additional details.", + "Returned when there is not an EKM key configured.", + "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", + "Returned when exception was encountered during evaluation of other criteria." + ], + "type": "string" + }, + "type": "array" + }, + "setupStatus": { + "description": "Indicates SAA enrollment status of a given workload.", + "enum": [ + "SETUP_STATE_UNSPECIFIED", + "STATUS_PENDING", + "STATUS_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "SAA enrollment pending.", + "SAA enrollment comopleted." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "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": "GoogleRpcStatus", + "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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "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": "GoogleRpcStatus", + "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" + } + }, + "servicePath": "", + "title": "Assured Workloads API", + "version": "v1beta1", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index 7708183b052..73b4d348a13 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -1307,7 +1307,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index c2c3fa23e29..7c63fbe0f2e 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -1741,7 +1741,7 @@ } } }, - "revision": "20220823", + "revision": "20220908", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3354,7 +3354,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 619806224ee..8214945aad6 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1710,7 +1710,7 @@ } } }, - "revision": "20220903", + "revision": "20220910", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2698,6 +2698,17 @@ }, "type": "object" }, + "DataMaskingStatistics": { + "id": "DataMaskingStatistics", + "properties": { + "dataMaskingApplied": { + "default": "false", + "description": "[Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.", + "type": "boolean" + } + }, + "type": "object" + }, "DataSplitResult": { "description": "Data split result. This contains references to the training and evaluation data tables that were used to train the model.", "id": "DataSplitResult", @@ -4498,6 +4509,10 @@ "format": "int64", "type": "string" }, + "dataMaskingStatistics": { + "$ref": "DataMaskingStatistics", + "description": "[Output-only] Statistics for data masking. Present only for query and extract jobs." + }, "endTime": { "description": "[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json index 46afe67aee4..408361ac14c 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json @@ -395,7 +395,7 @@ } } }, - "revision": "20220903", + "revision": "20220910", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index c65a8129fa5..8b1d419764b 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1340,7 +1340,7 @@ } } }, - "revision": "20220903", + "revision": "20220910", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index ba33cc353aa..b36d8c5307c 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -823,7 +823,7 @@ } } }, - "revision": "20220906", + "revision": "20220910", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json index 1d2c9d676c9..07a0fa0dcb2 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20220906", + "revision": "20220910", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 4cda5abfb79..4dcad638282 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -1892,7 +1892,7 @@ } } }, - "revision": "20220819", + "revision": "20220914", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2100,7 +2100,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json index 86d5f260ef5..9936a6e0ba0 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20220902", + "revision": "20220909", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json index 7dce1d87e29..c8c8c75dd03 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, - "revision": "20220902", + "revision": "20220909", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v2.json b/googleapiclient/discovery_cache/documents/blogger.v2.json index cdb171a6c2d..007397583f7 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index 41ac13806f0..020a03ce039 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1684,7 +1684,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/books.v1.json b/googleapiclient/discovery_cache/documents/books.v1.json index 198e6b50e31..9a16fee152b 100644 --- a/googleapiclient/discovery_cache/documents/books.v1.json +++ b/googleapiclient/discovery_cache/documents/books.v1.json @@ -2671,7 +2671,7 @@ } } }, - "revision": "20220825", + "revision": "20220914", "rootUrl": "https://books.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index b18ffe842e9..3727e7911d3 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -323,7 +323,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "Date": { diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index 151411af618..391d927f181 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -975,7 +975,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AuthorizationAttemptInfo": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 61e5c88ef3a..f7edde5c4c8 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -642,7 +642,7 @@ } } }, - "revision": "20220906", + "revision": "20220915", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -721,7 +721,7 @@ "DATA_LOSS" ], "enumDescriptions": [ - "Not an error; returned on success HTTP Mapping: 200 OK", + "Not an error; returned on success. HTTP Mapping: 200 OK", "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 1e38ffd3949..bb1a0612d60 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -330,6 +330,42 @@ "https://www.googleapis.com/auth/chrome.management.reports.readonly" ] }, + "countChromeHardwareFleetDevices": { + "description": "Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947", + "flatPath": "v1/customers/{customersId}/reports:countChromeHardwareFleetDevices", + "httpMethod": "GET", + "id": "chromemanagement.customers.reports.countChromeHardwareFleetDevices", + "parameterOrder": [ + "customer" + ], + "parameters": { + "customer": { + "description": "Required. The customer ID or \"my_customer\".", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + }, + "orgUnitId": { + "description": "Optional. The ID of the organizational unit. If omitted, all data will be returned.", + "location": "query", + "type": "string" + }, + "readMask": { + "description": "Required. Mask of the fields that should be populated in the returned report.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+customer}/reports:countChromeHardwareFleetDevices", + "response": { + "$ref": "GoogleChromeManagementV1CountChromeHardwareFleetDevicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.reports.readonly" + ] + }, "countChromeVersions": { "description": "Generate report of installed Chrome versions.", "flatPath": "v1/customers/{customersId}/reports:countChromeVersions", @@ -595,7 +631,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -1209,6 +1245,41 @@ }, "type": "object" }, + "GoogleChromeManagementV1CountChromeHardwareFleetDevicesResponse": { + "description": "Response containing a list of devices with a specific type of hardware specification from the requested hardware type.", + "id": "GoogleChromeManagementV1CountChromeHardwareFleetDevicesResponse", + "properties": { + "cpuReports": { + "description": "The DeviceHardwareCountReport for device cpu type (for example Intel(R) Core(TM) i7-10610U CPU @ 1.80GHz).", + "items": { + "$ref": "GoogleChromeManagementV1DeviceHardwareCountReport" + }, + "type": "array" + }, + "memoryReports": { + "description": "The DeviceHardwareCountReport for device memory amount in gigabytes (for example 16).", + "items": { + "$ref": "GoogleChromeManagementV1DeviceHardwareCountReport" + }, + "type": "array" + }, + "modelReports": { + "description": "The DeviceHardwareCountReport for device model type (for example Acer C7 Chromebook).", + "items": { + "$ref": "GoogleChromeManagementV1DeviceHardwareCountReport" + }, + "type": "array" + }, + "storageReports": { + "description": "The DeviceHardwareCountReport for device storage amount in gigabytes (for example 128).", + "items": { + "$ref": "GoogleChromeManagementV1DeviceHardwareCountReport" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleChromeManagementV1CountChromeVersionsResponse": { "description": "Response containing requested browser versions details and counts.", "id": "GoogleChromeManagementV1CountChromeVersionsResponse", @@ -1423,6 +1494,22 @@ }, "type": "object" }, + "GoogleChromeManagementV1DeviceHardwareCountReport": { + "description": "Report for CountChromeDevicesPerHardwareSpecResponse, contains the count of devices with a unique hardware specification.", + "id": "GoogleChromeManagementV1DeviceHardwareCountReport", + "properties": { + "bucket": { + "description": "Public name of the hardware specification.", + "type": "string" + }, + "count": { + "description": "Count of devices with a unique hardware specification.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleChromeManagementV1DiskInfo": { "description": "Status of the single storage device.", "id": "GoogleChromeManagementV1DiskInfo", diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index e18505bf8c9..f93cdfc488a 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -428,10 +428,10 @@ }, "path": "v1/{+customer}/policies/files:uploadPolicyFile", "request": { - "$ref": "GoogleChromePolicyV1UploadPolicyFileRequest" + "$ref": "GoogleChromePolicyVersionsV1UploadPolicyFileRequest" }, "response": { - "$ref": "GoogleChromePolicyV1UploadPolicyFileResponse" + "$ref": "GoogleChromePolicyVersionsV1UploadPolicyFileResponse" }, "scopes": [ "https://www.googleapis.com/auth/chrome.management.policy" @@ -441,7 +441,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle": { @@ -1040,9 +1040,9 @@ }, "type": "object" }, - "GoogleChromePolicyV1UploadPolicyFileRequest": { + "GoogleChromePolicyVersionsV1UploadPolicyFileRequest": { "description": "Request message for uploading a file for a policy. Next ID: 5", - "id": "GoogleChromePolicyV1UploadPolicyFileRequest", + "id": "GoogleChromePolicyVersionsV1UploadPolicyFileRequest", "properties": { "policyField": { "description": "Required. The fully qualified policy schema and field name this file is uploaded for. This information will be used to validate the content type of the file.", @@ -1051,9 +1051,9 @@ }, "type": "object" }, - "GoogleChromePolicyV1UploadPolicyFileResponse": { + "GoogleChromePolicyVersionsV1UploadPolicyFileResponse": { "description": "Response message for downloading an uploaded file. Next ID: 2", - "id": "GoogleChromePolicyV1UploadPolicyFileResponse", + "id": "GoogleChromePolicyVersionsV1UploadPolicyFileResponse", "properties": { "downloadUri": { "description": "The uri for end user to download the file.", diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index c1013e8768a..dbe4b3bca37 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20220908", + "revision": "20220915", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { diff --git a/googleapiclient/discovery_cache/documents/civicinfo.v2.json b/googleapiclient/discovery_cache/documents/civicinfo.v2.json index 49237240158..e0ae0200a12 100644 --- a/googleapiclient/discovery_cache/documents/civicinfo.v2.json +++ b/googleapiclient/discovery_cache/documents/civicinfo.v2.json @@ -352,7 +352,7 @@ } } }, - "revision": "20220906", + "revision": "20220913", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index a5dac71ee1f..e8fe4dc7682 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -2400,7 +2400,7 @@ } } }, - "revision": "20220907", + "revision": "20220914", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "Announcement": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json index 0964cf691cb..4d301fd06c2 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json @@ -521,7 +521,7 @@ } } }, - "revision": "20220908", + "revision": "20220914", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json new file mode 100644 index 00000000000..f1e5f9eb99c --- /dev/null +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json @@ -0,0 +1,871 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-billing": { + "description": "View and manage your Google Cloud Platform billing accounts" + }, + "https://www.googleapis.com/auth/cloud-billing.readonly": { + "description": "View your Google Cloud Platform billing accounts" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://cloudbilling.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloudbilling", + "description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/billing/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "cloudbilling:v1beta", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudbilling.mtls.googleapis.com/", + "name": "cloudbilling", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "billingAccounts": { + "methods": { + "estimateCostScenario": { + "description": "Use custom pricing in the estimate, using a `CostScenario` with a defined `billingAccount`.", + "flatPath": "v1beta/billingAccounts/{billingAccountsId}:estimateCostScenario", + "httpMethod": "POST", + "id": "cloudbilling.billingAccounts.estimateCostScenario", + "parameterOrder": [ + "billingAccount" + ], + "parameters": { + "billingAccount": { + "description": "Resource name of the billing account for the cost estimate. The resource name has the form `billingAccounts/{billing_acount_id}`. For example, `billingAccounts/012345-567890-ABCDEF` is the resource name for billing account `012345-567890-ABCDEF`. Must be specified.", + "location": "path", + "pattern": "^billingAccounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+billingAccount}:estimateCostScenario", + "request": { + "$ref": "EstimateCostScenarioForBillingAccountRequest" + }, + "response": { + "$ref": "EstimateCostScenarioForBillingAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-billing", + "https://www.googleapis.com/auth/cloud-billing.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "v1beta": { + "methods": { + "estimateCostScenario": { + "description": "Estimate list prices using a `CostScenario` without a defined `billingAccount`.", + "flatPath": "v1beta:estimateCostScenario", + "httpMethod": "POST", + "id": "cloudbilling.estimateCostScenario", + "parameterOrder": [], + "parameters": {}, + "path": "v1beta:estimateCostScenario", + "request": { + "$ref": "EstimateCostScenarioWithListPriceRequest" + }, + "response": { + "$ref": "EstimateCostScenarioWithListPriceResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-billing", + "https://www.googleapis.com/auth/cloud-billing.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + }, + "revision": "20220914", + "rootUrl": "https://cloudbilling.googleapis.com/", + "schemas": { + "CloudStorageWorkload": { + "description": "Specifies usage of Cloud Storage resources.", + "id": "CloudStorageWorkload", + "properties": { + "dataRetrieval": { + "$ref": "Usage", + "description": "Data retrieval usage. A retrieval cost applies when data or metadata is read, copied, or rewritten . For example: units such as \"GiBy/s\" or \"By/s\"." + }, + "dataStored": { + "$ref": "Usage", + "description": "Data storage usage. The amount of data stored in buckets. For example: units such as \"GiBy/s\" or \"TBy/mo\"." + }, + "dualRegion": { + "$ref": "DualRegional", + "description": "Specify dual regions." + }, + "multiRegion": { + "$ref": "MultiRegional", + "description": "Specify multi regions." + }, + "operationA": { + "$ref": "Usage", + "description": "Class A operation usage in Cloud Storage, such as listing the objects in buckets. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as \"1/s\"." + }, + "operationB": { + "$ref": "Usage", + "description": "Class B operation usage in Cloud Storage, such as `getIamPolicy`. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as \"1/s\"." + }, + "region": { + "$ref": "Regional", + "description": "Specify a single region." + }, + "storageClass": { + "description": "The [storage class](https://cloud.google.com/storage/docs/storage-classes#classes) of the data and operation. For example: \"standard\" or \"nearline\".", + "type": "string" + } + }, + "type": "object" + }, + "Commitment": { + "description": "Commitments give you the ability to pay a recurring fee in exchange for a benefit, such as a discount for your use. For example, this object might contain details of a [spend-based committed use discount (CUD)](https://cloud.google.com/docs/cuds#spend_based_commitments). Within a CostScenario, adding a commitment includes the cost of the commitment and any discounts.", + "id": "Commitment", + "properties": { + "name": { + "description": "Required. A name for this commitment. All commitments in a CostScenario must have unique names. Each name must be a maximum of 32 characters.", + "type": "string" + }, + "vmResourceBasedCud": { + "$ref": "VmResourceBasedCud", + "description": "A resource-based committed use discount (CUD)." + } + }, + "type": "object" + }, + "CommitmentCostEstimate": { + "description": "Estimated cost for a commitment.", + "id": "CommitmentCostEstimate", + "properties": { + "commitmentTotalCostEstimate": { + "$ref": "CostEstimate", + "description": "Total estimated costs for the commitment." + }, + "name": { + "description": "The name of the commitment, as specified in the `CostScenario`.", + "type": "string" + }, + "skuCostEstimates": { + "description": "Estimated costs for each SKU in the commitment.", + "items": { + "$ref": "SkuCostEstimate" + }, + "type": "array" + } + }, + "type": "object" + }, + "ComputeVmWorkload": { + "description": "Specificies usage of a set of identical compute VM instances.", + "id": "ComputeVmWorkload", + "properties": { + "enableConfidentialCompute": { + "description": "Defines whether each instance has confidential compute enabled.", + "type": "boolean" + }, + "guestAccelerator": { + "$ref": "GuestAccelerator", + "description": "Guest accelerators attached to each machine." + }, + "instancesRunning": { + "$ref": "Usage", + "description": "VM usage. This is specified as a unitless quantity which indicates the number of instances running." + }, + "licenses": { + "description": "Premium image licenses used by each instance.", + "items": { + "type": "string" + }, + "type": "array" + }, + "machineType": { + "$ref": "MachineType", + "description": "The machine type." + }, + "persistentDisks": { + "description": "Persistent disks attached to each instance. Must include a boot disk.", + "items": { + "$ref": "PersistentDisk" + }, + "type": "array" + }, + "preemptible": { + "description": "Defines whether each instance is preemptible.", + "type": "boolean" + }, + "region": { + "description": "The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: \"us-central1\".", + "type": "string" + } + }, + "type": "object" + }, + "CostEstimate": { + "description": "An estimated cost.", + "id": "CostEstimate", + "properties": { + "creditEstimates": { + "description": "The estimated credits applied.", + "items": { + "$ref": "CreditEstimate" + }, + "type": "array" + }, + "netCostEstimate": { + "$ref": "Money", + "description": "The estimated net cost after applying credits." + }, + "preCreditCostEstimate": { + "$ref": "Money", + "description": "The estimated cost prior to applying credits." + } + }, + "type": "object" + }, + "CostEstimationResult": { + "description": "The result of a estimating the costs of a `CostScenario`.", + "id": "CostEstimationResult", + "properties": { + "currencyCode": { + "description": "Required. The ISO 4217 currency code for the cost estimate.", + "type": "string" + }, + "segmentCostEstimates": { + "description": "Required. Estimated costs for each idealized month of a `CostScenario`.", + "items": { + "$ref": "SegmentCostEstimate" + }, + "type": "array" + }, + "skus": { + "description": "Required. Information about SKUs used in the estimate.", + "items": { + "$ref": "Sku" + }, + "type": "array" + } + }, + "type": "object" + }, + "CostScenario": { + "description": "Encapsulates all the information needed to perform a cost estimate. It includes a specification of the Google Cloud usage whose costs are estimated, and configuration options.", + "id": "CostScenario", + "properties": { + "commitments": { + "description": "New commitments to estimate the costs for. The cost of the commitments will be included in the estimate result and discounts the commitment entitles will be included in the workload cost estimates. A maximum of 100 workloads can be provided.", + "items": { + "$ref": "Commitment" + }, + "type": "array" + }, + "scenarioConfig": { + "$ref": "ScenarioConfig", + "description": "Configuration for the scenario." + }, + "workloads": { + "description": "The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided.", + "items": { + "$ref": "Workload" + }, + "type": "array" + } + }, + "type": "object" + }, + "CreditEstimate": { + "description": "An estimated credit applied to the costs on a SKU.", + "id": "CreditEstimate", + "properties": { + "creditAmount": { + "$ref": "Money", + "description": "The estimated credit amount." + }, + "creditDescription": { + "description": "The credit description.", + "type": "string" + }, + "creditType": { + "description": "The credit type.", + "type": "string" + } + }, + "type": "object" + }, + "CustomMachineType": { + "description": "Specification of a custom machine type.", + "id": "CustomMachineType", + "properties": { + "machineSeries": { + "description": "Required. The machine series. Only certain [machine series](https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types) support custom configurations. For example: \"n1\".", + "type": "string" + }, + "memorySizeGb": { + "description": "Required. Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB). Each [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison) has limitations on allowed values for the ratio of memory-to-vCPU count.", + "format": "double", + "type": "number" + }, + "virtualCpuCount": { + "description": "Required. The number of vCPUs. The allowed values depend on the [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DualRegional": { + "description": "Area contains dual locations.", + "id": "DualRegional", + "properties": { + "name": { + "description": "The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: \"asia1\" for dual region.", + "type": "string" + } + }, + "type": "object" + }, + "EstimateCostScenarioForBillingAccountRequest": { + "description": "Request for EstimateCostScenarioForBillingAccount.", + "id": "EstimateCostScenarioForBillingAccountRequest", + "properties": { + "costScenario": { + "$ref": "CostScenario", + "description": "The scenario to estimate costs for." + } + }, + "type": "object" + }, + "EstimateCostScenarioForBillingAccountResponse": { + "description": "Response for EstimateCostScenarioForBillingAccount", + "id": "EstimateCostScenarioForBillingAccountResponse", + "properties": { + "costEstimationResult": { + "$ref": "CostEstimationResult", + "description": "The result of the cost estimation." + } + }, + "type": "object" + }, + "EstimateCostScenarioWithListPriceRequest": { + "description": "Request for EstimateCostScenarioWithListPrice.", + "id": "EstimateCostScenarioWithListPriceRequest", + "properties": { + "costScenario": { + "$ref": "CostScenario", + "description": "The scenario to estimate costs for." + } + }, + "type": "object" + }, + "EstimateCostScenarioWithListPriceResponse": { + "description": "Response for EstimateCostScenarioWithListPrice", + "id": "EstimateCostScenarioWithListPriceResponse", + "properties": { + "costEstimationResult": { + "$ref": "CostEstimationResult", + "description": "The result of the cost estimation." + } + }, + "type": "object" + }, + "EstimationTimePoint": { + "description": "Represents a point in time.", + "id": "EstimationTimePoint", + "properties": { + "estimationTimeFrameOffset": { + "description": "The point in time, relative to the start of the time frame covered by the cost estimate.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GuestAccelerator": { + "description": "Specification of a set of guest accelerators attached to a machine.", + "id": "GuestAccelerator", + "properties": { + "acceleratorCount": { + "description": "The number of the guest accelerator cards exposed to each instance.", + "format": "int64", + "type": "string" + }, + "acceleratorType": { + "description": "The type of the guest accelerator cards. For example: \"nvidia-tesla-t4\".", + "type": "string" + } + }, + "type": "object" + }, + "MachineType": { + "description": "Specification of machine series, memory, and number of vCPUs.", + "id": "MachineType", + "properties": { + "customMachineType": { + "$ref": "CustomMachineType" + }, + "predefinedMachineType": { + "$ref": "PredefinedMachineType" + } + }, + "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" + }, + "MultiRegional": { + "description": "Area contains multiple locations.", + "id": "MultiRegional", + "properties": { + "name": { + "description": "The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: \"us\" for multi-region.", + "type": "string" + } + }, + "type": "object" + }, + "PersistentDisk": { + "description": "Specification of a persistent disk attached to a VM.", + "id": "PersistentDisk", + "properties": { + "diskSize": { + "$ref": "Usage", + "description": "Specifies the size of disk. Must be at least 10 GB." + }, + "diskType": { + "description": "The [disk type](https://cloud.google.com/compute/docs/disks#disk-types). For example: \"pd-standard\".", + "type": "string" + }, + "provisionedIops": { + "$ref": "Usage", + "description": "Indicates how many IOPS to provision for the disk for extreme persistent disks. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000." + }, + "scope": { + "description": "The geographic scope of the disk. Defaults to `SCOPE_ZONAL` if not specified.", + "enum": [ + "SCOPE_UNSPECIFIED", + "SCOPE_ZONAL", + "SCOPE_REGIONAL" + ], + "enumDescriptions": [ + "Unspecified.", + "The disk exists in a single zone.", + "The disk is replicated in a secondary zone within the same region." + ], + "type": "string" + } + }, + "type": "object" + }, + "PredefinedMachineType": { + "description": "Specification of a predefined machine type.", + "id": "PredefinedMachineType", + "properties": { + "machineType": { + "description": "The [machine type](https://cloud.google.com/compute/docs/machine-types). For example: \"n1-standard1\".", + "type": "string" + } + }, + "type": "object" + }, + "Price": { + "description": "The price of a SKU at a point int time.", + "id": "Price", + "properties": { + "effectiveTime": { + "$ref": "EstimationTimePoint", + "description": "The timestamp within the estimation time frame when the price was set." + }, + "priceType": { + "description": "The type of price. Possible values: \"RATE\"", + "type": "string" + }, + "rate": { + "$ref": "Rate", + "description": "A set of tiered rates." + } + }, + "type": "object" + }, + "Rate": { + "description": "A SKU price consisting of tiered rates.", + "id": "Rate", + "properties": { + "tiers": { + "description": "The service tiers.", + "items": { + "$ref": "RateTier" + }, + "type": "array" + }, + "unit": { + "description": "The SKU's pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this field will show 'By'. The `start_amount` field in each tier will be in this unit.", + "type": "string" + }, + "unitCount": { + "description": "The SKU's count for the pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this column will show 1000000.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "RateTier": { + "description": "Pricing details for a service tier.", + "id": "RateTier", + "properties": { + "price": { + "$ref": "Money", + "description": "The price for this tier." + }, + "startAmount": { + "description": "The magnitude of usage in which the tier interval begins. Example: \"From 100 GiBi the price is $1 per byte\" implies `start_amount` = 100", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Regional": { + "description": "Area contains only one location.", + "id": "Regional", + "properties": { + "name": { + "description": "The [location name](https://cloud.google.com/storage/docs/locations#available-locations). For example: \"us-central1\" for region.", + "type": "string" + } + }, + "type": "object" + }, + "ScenarioConfig": { + "description": "Configuration for a CostScenario. Specifies how costs are calculated.", + "id": "ScenarioConfig", + "properties": { + "estimateDuration": { + "description": "Time frame for the estimate. Workloads must specify usage for this duration. Duration must be at least 1 hour (3,600 seconds) and at most 10 years (315,360,000 seconds). The calculations for years and months are based on a 730-hour (2,628,000-second) month.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "SegmentCostEstimate": { + "description": "Workload cost estimates for a single time segment.", + "id": "SegmentCostEstimate", + "properties": { + "commitmentCostEstimates": { + "description": "Estimated costs for each commitment.", + "items": { + "$ref": "CommitmentCostEstimate" + }, + "type": "array" + }, + "segmentStartTime": { + "$ref": "EstimationTimePoint", + "description": "Timestamp for the start of the segment." + }, + "segmentTotalCostEstimate": { + "$ref": "CostEstimate", + "description": "Total estimated costs for the time segment." + }, + "workloadCostEstimates": { + "description": "Estimated costs for each workload.", + "items": { + "$ref": "WorkloadCostEstimate" + }, + "type": "array" + } + }, + "type": "object" + }, + "Sku": { + "description": "Information about SKUs appearing in the cost estimate.", + "id": "Sku", + "properties": { + "displayName": { + "description": "The display name for the SKU. Example: A2 Instance Core running in Americas", + "type": "string" + }, + "prices": { + "description": "A timeline of prices for a SKU in chronological order. Note: The API currently only supports using a constant price for the entire estimation time frame so this list will contain a single value.", + "items": { + "$ref": "Price" + }, + "type": "array" + }, + "sku": { + "description": "The resource name for the SKU. Example: \"services/DA34-426B-A397/skus/AA95-CD31-42FE\"", + "type": "string" + } + }, + "type": "object" + }, + "SkuCostEstimate": { + "description": "Estimated cost for usage on a SKU.", + "id": "SkuCostEstimate", + "properties": { + "costEstimate": { + "$ref": "CostEstimate", + "description": "The estimated cost for the usage on this SKU." + }, + "sku": { + "description": "The resource name for the SKU. Example: \"services/DA34-426B-A397/skus/AA95-CD31-42FE\" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.", + "type": "string" + }, + "usageAmount": { + "description": "The amount of usage on this SKU.", + "format": "double", + "type": "number" + }, + "usageUnit": { + "description": "The unit for the usage on this SKU.", + "type": "string" + } + }, + "type": "object" + }, + "Usage": { + "description": "An amount of usage over a time frame.", + "id": "Usage", + "properties": { + "usageRateTimeline": { + "$ref": "UsageRateTimeline", + "description": "A timeline of usage rates over the estimate interval." + } + }, + "type": "object" + }, + "UsageRateTimeline": { + "description": "A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours.", + "id": "UsageRateTimeline", + "properties": { + "unit": { + "description": "The unit for the usage rate in each timeline entry. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = \"{\" NAME \"}\" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`", + "type": "string" + }, + "usageRateTimelineEntries": { + "description": "The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.", + "items": { + "$ref": "UsageRateTimelineEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "UsageRateTimelineEntry": { + "description": "A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.", + "id": "UsageRateTimelineEntry", + "properties": { + "effectiveTime": { + "$ref": "EstimationTimePoint", + "description": "The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours." + }, + "usageRate": { + "description": "The usage rate.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "VmResourceBasedCud": { + "description": "Specifies a resource-based committed use discount (CUD).", + "id": "VmResourceBasedCud", + "properties": { + "guestAccelerator": { + "$ref": "GuestAccelerator", + "description": "Guest accelerator, known as GPU." + }, + "machineSeries": { + "description": "The machine series for CUD. For example: \"n1\" for general purpose N1 machine type commitments. \"n2\" for general purpose N2 machine type commitments. \"e2\" for general purpose E2 machine type commitments. \"n2d\" for general purpose N2D machine type commitments. \"t2d\" for general purpose T2D machine type commitments. \"c2\"/\"c2d\" for compute-optimized commitments. \"m1\"/\"m2\" for the memory-optimized commitments. \"a2' for the accelerator-optimized commitments.", + "type": "string" + }, + "memorySizeGb": { + "description": "Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB).", + "format": "double", + "type": "number" + }, + "plan": { + "description": "Commitment usage plan.", + "enum": [ + "COMMITMENT_PLAN_UNSPECIFIED", + "TWELVE_MONTH", + "THIRTY_SIX_MONTH" + ], + "enumDescriptions": [ + "Not specified commitment plan.", + "1 year commitment.", + "3 years commitment." + ], + "type": "string" + }, + "region": { + "description": "The region where the VM runs. For example: \"us-central1\"", + "type": "string" + }, + "virtualCpuCount": { + "description": "The number of vCPUs. The number of vCPUs must be an integer of 0 or more and can be even or odd.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Workload": { + "description": "Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed.", + "id": "Workload", + "properties": { + "cloudStorageWorkload": { + "$ref": "CloudStorageWorkload", + "description": "Usage on Google Cloud Storage." + }, + "computeVmWorkload": { + "$ref": "ComputeVmWorkload", + "description": "Usage of a Google Compute Engine Virtual Machine." + }, + "name": { + "description": "Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` must be a maximum of 32 characters.", + "type": "string" + } + }, + "type": "object" + }, + "WorkloadCostEstimate": { + "description": "Estimated cost for a workload.", + "id": "WorkloadCostEstimate", + "properties": { + "name": { + "description": "The name of the workload, as specified in the `CostScenario`.", + "type": "string" + }, + "skuCostEstimates": { + "description": "Estimated costs for each SKU in the workload.", + "items": { + "$ref": "SkuCostEstimate" + }, + "type": "array" + }, + "workloadTotalCostEstimate": { + "$ref": "CostEstimate", + "description": "Total estimated costs for the workload." + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Billing API", + "version": "v1beta", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 781ab8da12d..dc9290a144d 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2036,7 +2036,7 @@ } } }, - "revision": "20220826", + "revision": "20220908", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json index 83343f5cdae..a6f17e08b4e 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha1.json @@ -306,7 +306,7 @@ } } }, - "revision": "20220826", + "revision": "20220908", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json index 2753426b4c8..bee30c56267 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1alpha2.json @@ -317,7 +317,7 @@ } } }, - "revision": "20220826", + "revision": "20220908", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json index 6cdd5361217..6d4b1e3d158 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1beta1.json @@ -322,7 +322,7 @@ } } }, - "revision": "20220826", + "revision": "20220908", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index bfe4f444856..554f2622918 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -1901,7 +1901,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { diff --git a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json index d0398435251..d2513afe419 100644 --- a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json +++ b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json @@ -448,7 +448,7 @@ } } }, - "revision": "20220902", + "revision": "20220909", "rootUrl": "https://clouddebugger.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 8b55326efd9..64a8506e643 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -795,6 +795,111 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "retryJob": { + "description": "Retries the specified Job in a Rollout.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:retryJob", + "httpMethod": "POST", + "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.retryJob", + "parameterOrder": [ + "rollout" + ], + "parameters": { + "rollout": { + "description": "Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+rollout}:retryJob", + "request": { + "$ref": "RetryJobRequest" + }, + "response": { + "$ref": "RetryJobResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "jobRuns": { + "methods": { + "get": { + "description": "Gets details of a single JobRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns/{jobRunsId}", + "httpMethod": "GET", + "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the `JobRun`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+/jobRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "JobRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists JobRuns in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns", + "httpMethod": "GET", + "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of `JobRun` objects to return. The service may return fewer than this value. If unspecified, at most 50 `JobRun` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListJobRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The `Rollout` which owns this collection of `JobRun` objects.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/jobRuns", + "response": { + "$ref": "ListJobRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } @@ -1229,7 +1334,7 @@ } } }, - "revision": "20220906", + "revision": "20220909", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -1368,7 +1473,7 @@ "id": "CloudRunLocation", "properties": { "location": { - "description": "Required. The location where the Cloud Run Service should be located. Format is `projects/{project}/locations/{location}`.", + "description": "Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`.", "type": "string" } }, @@ -1552,6 +1657,63 @@ }, "type": "object" }, + "DeployJob": { + "description": "A deploy Job.", + "id": "DeployJob", + "properties": {}, + "type": "object" + }, + "DeployJobRun": { + "description": "DeployJobRun contains information specific to a deploy `JobRun`.", + "id": "DeployJobRun", + "properties": { + "build": { + "description": "Output only. The resource name of the Cloud Build `Build` object that is used to deploy. Format is projects/{project}/locations/{location}/builds/{build}.", + "readOnly": true, + "type": "string" + }, + "failureCause": { + "description": "Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded.", + "enum": [ + "FAILURE_CAUSE_UNSPECIFIED", + "CLOUD_BUILD_UNAVAILABLE", + "EXECUTION_FAILED", + "DEADLINE_EXCEEDED" + ], + "enumDescriptions": [ + "No reason for failure is specified.", + "Cloud Build is not available, either because it is not enabled or because Google Cloud Deploy has insufficient permissions. See [Required permission](/deploy/docs/cloud-deploy-service-account#required_permissions).", + "The deploy operation did not complete successfully; check Cloud Build logs.", + "The deploy build did not complete within the alloted time." + ], + "readOnly": true, + "type": "string" + }, + "failureMessage": { + "description": "Output only. Additional information about the deploy failure, if available.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DeploymentJobs": { + "description": "Deployment job composition.", + "id": "DeploymentJobs", + "properties": { + "deployJob": { + "$ref": "Job", + "description": "Output only. The deploy Job. This is the first job run in the phase.", + "readOnly": true + }, + "verifyJob": { + "$ref": "Job", + "description": "Output only. The verify Job. Runs after a deploy if the deploy succeeds.", + "readOnly": true + } + }, + "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", @@ -1589,12 +1751,14 @@ "enum": [ "EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED", "RENDER", - "DEPLOY" + "DEPLOY", + "VERIFY" ], "enumDescriptions": [ "Default value. This value is unused.", "Use for rendering.", - "Use for deploying and deployment hooks." + "Use for deploying and deployment hooks.", + "Use for deployment verification." ], "type": "string" }, @@ -1645,6 +1809,132 @@ }, "type": "object" }, + "Job": { + "description": "Job represents an operation for a `Rollout`.", + "id": "Job", + "properties": { + "deployJob": { + "$ref": "DeployJob", + "description": "Output only. A deploy Job.", + "readOnly": true + }, + "id": { + "description": "Output only. The ID of the Job.", + "readOnly": true, + "type": "string" + }, + "jobRun": { + "description": "Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the Job.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "DISABLED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED", + "ABORTED" + ], + "enumDescriptions": [ + "The Job has an unspecified state.", + "The Job is waiting for an earlier Phase(s) or Job(s) to complete.", + "The Job is disabled.", + "The Job is in progress.", + "The Job succeeded.", + "The Job failed.", + "The Job was aborted." + ], + "readOnly": true, + "type": "string" + }, + "verifyJob": { + "$ref": "VerifyJob", + "description": "Output only. A verify Job.", + "readOnly": true + } + }, + "type": "object" + }, + "JobRun": { + "description": "A `JobRun` resource in the Google Cloud Deploy API. A `JobRun` contains information of a single `Rollout` job evaluation.", + "id": "JobRun", + "properties": { + "createTime": { + "description": "Output only. Time at which the `JobRun` was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deployJobRun": { + "$ref": "DeployJobRun", + "description": "Output only. Information specific to a deploy `JobRun`.", + "readOnly": true + }, + "endTime": { + "description": "Output only. Time at which the `JobRun` ended.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "readOnly": true, + "type": "string" + }, + "jobId": { + "description": "Output only. ID of the `Rollout` job this `JobRun` corresponds to.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Optional. Name of the `JobRun`. Format is projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/ {rollouts}/jobRuns/{uuid}.", + "type": "string" + }, + "phaseId": { + "description": "Output only. ID of the `Rollout` phase this `JobRun` belongs in.", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. Time at which the `JobRun` was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the `JobRun`.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The `JobRun` has an unspecified state.", + "The `JobRun` is in progress.", + "The `JobRun` has succeeded.", + "The `JobRun` has failed." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. Unique identifier of the `JobRun`.", + "readOnly": true, + "type": "string" + }, + "verifyJobRun": { + "$ref": "VerifyJobRun", + "description": "Output only. Information specific to a verify `JobRun`.", + "readOnly": true + } + }, + "type": "object" + }, "ListDeliveryPipelinesResponse": { "description": "The response object from `ListDeliveryPipelines`.", "id": "ListDeliveryPipelinesResponse", @@ -1670,6 +1960,31 @@ }, "type": "object" }, + "ListJobRunsResponse": { + "description": "ListJobRunsResponse is the response object returned by `ListJobRuns`.", + "id": "ListJobRunsResponse", + "properties": { + "jobRuns": { + "description": "The `JobRun` objects.", + "items": { + "$ref": "JobRun" + }, + "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": "Locations that could not be reached", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -1816,7 +2131,7 @@ "type": "object" }, "Metadata": { - "description": "Metadata surfaces information associated with a `Rollout` to the user.", + "description": "Metadata includes information associated with a `Rollout`.", "id": "Metadata", "properties": { "cloudRun": { @@ -1906,6 +2221,44 @@ }, "type": "object" }, + "Phase": { + "description": "Phase represents a collection of jobs that are logically grouped together for a `Rollout`.", + "id": "Phase", + "properties": { + "deploymentJobs": { + "$ref": "DeploymentJobs", + "description": "Output only. Deployment job composition.", + "readOnly": true + }, + "id": { + "description": "Output only. The ID of the Phase.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. Current state of the Phase.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED", + "ABORTED" + ], + "enumDescriptions": [ + "The Phase has an unspecified state.", + "The Phase is waiting for an earlier Phase(s) to complete.", + "The Phase is in progress.", + "The Phase has succeeded.", + "The Phase has failed.", + "The Phase was aborted." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PipelineCondition": { "description": "PipelineCondition contains all conditions relevant to a Delivery Pipeline.", "id": "PipelineCondition", @@ -2157,6 +2510,27 @@ }, "type": "object" }, + "RetryJobRequest": { + "description": "RetryJobRequest is the request object used by `RetryJob`.", + "id": "RetryJobRequest", + "properties": { + "jobId": { + "description": "Required. The job ID for the Job to retry.", + "type": "string" + }, + "phaseId": { + "description": "Required. The phase ID the Job to retry belongs to.", + "type": "string" + } + }, + "type": "object" + }, + "RetryJobResponse": { + "description": "The response object from 'RetryJob'.", + "id": "RetryJobResponse", + "properties": {}, + "type": "object" + }, "Rollout": { "description": "A `Rollout` resource in the Google Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.", "id": "Rollout", @@ -2213,7 +2587,8 @@ "EXECUTION_FAILED", "DEADLINE_EXCEEDED", "RELEASE_FAILED", - "RELEASE_ABANDONED" + "RELEASE_ABANDONED", + "VERIFICATION_CONFIG_NOT_FOUND" ], "enumDescriptions": [ "No reason for failure is specified.", @@ -2221,7 +2596,8 @@ "The deploy operation did not complete successfully; check Cloud Build logs.", "Deployment did not complete within the alloted time.", "Release is in a failed state.", - "Release is abandoned." + "Release is abandoned.", + "No skaffold verify configuration was found." ], "readOnly": true, "type": "string" @@ -2272,6 +2648,14 @@ "description": "Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.", "type": "string" }, + "phases": { + "description": "Output only. The phases that represent the workflows of this `Rollout`.", + "items": { + "$ref": "Phase" + }, + "readOnly": true, + "type": "array" + }, "state": { "description": "Output only. Current state of the `Rollout`.", "enum": [ @@ -2406,6 +2790,10 @@ }, "type": "array" }, + "strategy": { + "$ref": "Strategy", + "description": "Optional. The strategy to use for a `Rollout` to this stage." + }, "targetId": { "description": "The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`.", "type": "string" @@ -2413,6 +2801,17 @@ }, "type": "object" }, + "Standard": { + "description": "Standard represents the standard deployment strategy.", + "id": "Standard", + "properties": { + "verify": { + "description": "Whether to verify a deployment.", + "type": "boolean" + } + }, + "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", @@ -2440,6 +2839,17 @@ }, "type": "object" }, + "Strategy": { + "description": "Strategy contains deployment strategy information.", + "id": "Strategy", + "properties": { + "standard": { + "$ref": "Standard", + "description": "Standard deployment strategy executes a single deploy and allows verifying the deployment." + } + }, + "type": "object" + }, "Target": { "description": "A `Target` resource in the Google Cloud Deploy API. A `Target` defines a location to which a Skaffold configuration can be deployed.", "id": "Target", @@ -2582,7 +2992,7 @@ ], "enumDescriptions": [ "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](/deploy/docs/cloud-deploy-service-account#required_permissions).", + "Cloud Build is not available, either because it is not enabled or because Google Cloud Deploy has insufficient permissions. See [required permission](/deploy/docs/cloud-deploy-service-account#required_permissions).", "The render operation did not complete successfully; check Cloud Build logs." ], "readOnly": true, @@ -2668,6 +3078,58 @@ } }, "type": "object" + }, + "VerifyJob": { + "description": "A verify Job.", + "id": "VerifyJob", + "properties": {}, + "type": "object" + }, + "VerifyJobRun": { + "description": "VerifyJobRun contains information specific to a verify `JobRun`.", + "id": "VerifyJobRun", + "properties": { + "artifactUri": { + "description": "Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.", + "readOnly": true, + "type": "string" + }, + "build": { + "description": "Output only. The resource name of the Cloud Build `Build` object that is used to verify. Format is projects/{project}/locations/{location}/builds/{build}.", + "readOnly": true, + "type": "string" + }, + "eventLogPath": { + "description": "Output only. File path of the Skaffold event log relative to the artifact URI.", + "readOnly": true, + "type": "string" + }, + "failureCause": { + "description": "Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded.", + "enum": [ + "FAILURE_CAUSE_UNSPECIFIED", + "CLOUD_BUILD_UNAVAILABLE", + "EXECUTION_FAILED", + "DEADLINE_EXCEEDED", + "VERIFICATION_CONFIG_NOT_FOUND" + ], + "enumDescriptions": [ + "No reason for failure is specified.", + "Cloud Build is not available, either because it is not enabled or because Google Cloud Deploy has insufficient permissions. See [required permission](/deploy/docs/cloud-deploy-service-account#required_permissions).", + "The verify operation did not complete successfully; check Cloud Build logs.", + "The verify build did not complete within the alloted time.", + "No Skaffold verify configuration was found." + ], + "readOnly": true, + "type": "string" + }, + "failureMessage": { + "description": "Output only. Additional information about the verify failure, if available.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index 795cfd5e51f..2e630942cb7 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1546,7 +1546,7 @@ } } }, - "revision": "20220904", + "revision": "20220913", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "CancelUserInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 53cb264871f..b0494925c9c 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -1536,7 +1536,7 @@ } } }, - "revision": "20220904", + "revision": "20220913", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AndroidAttributes": { diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 64cce34e9c8..5bb5dfdea4c 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -1582,7 +1582,7 @@ } } }, - "revision": "20220902", + "revision": "20220909", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json index 87b67779bbc..9b673ce26f6 100644 --- a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json @@ -216,7 +216,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://cloudprofiler.googleapis.com/", "schemas": { "CreateProfileRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json index 7e91de07dbb..85e129fff64 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -1171,7 +1171,7 @@ } } }, - "revision": "20220901", + "revision": "20220914", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json index a39498d0de5..8dee161ec2e 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20220901", + "revision": "20220914", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json index 441ced8c456..8335db1cfdd 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20220901", + "revision": "20220914", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json index 5280be4152a..d3a454f3952 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20220901", + "revision": "20220914", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json index a3f3ca3a82a..e49034da457 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -984,7 +984,7 @@ ] }, "setIamPolicy": { - "description": "Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. + Calling this method requires enabling the App Engine Admin API.", + "description": "Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.", "flatPath": "v3/projects/{projectsId}:setIamPolicy", "httpMethod": "POST", "id": "cloudresourcemanager.projects.setIamPolicy", @@ -1760,7 +1760,7 @@ } } }, - "revision": "20220901", + "revision": "20220914", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json index d5ffd6e88af..2341c146df7 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -2059,7 +2059,7 @@ } } }, - "revision": "20220904", + "revision": "20220913", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "AbuseReportingConfig": { @@ -2583,9 +2583,14 @@ "type": "object" }, "AppsDynamiteSharedActivityFeedAnnotationData": { - "description": "Next Id: 6", + "description": "Next Id: 7", "id": "AppsDynamiteSharedActivityFeedAnnotationData", "properties": { + "activityFeedMessageCreateTime": { + "description": "Timestamp of when the Activity Feed message that contains this annotation was created. This is roughly when the activity happened, such as when a reaction happened, but will have at least some small delay, since the Activity Feed message is created asynchronously after. This timestamp should only be used for display when the activity create time is not available in the Chat UI, like the time of a reaction.", + "format": "google-datetime", + "type": "string" + }, "activityFeedMessageId": { "$ref": "MessageId", "description": "Unique id of the Activity Feed message used by clients to implement click-to-source. This is the same messageId as the top-level id field for the Activity Feed item." @@ -3368,7 +3373,7 @@ "A flat room that contains a single thread.", "A threaded room. Topics in this room are threaded, and users can reply to any topic.", "A DM with immutable group membership. It can be a 1:1 DM or a group DM with multiple human users.", - "A post room. Topics in this room are organized in a post/reply style. See the design doc for more details: go/PostRoomsInDynamite.", + "A post room. Topics in this room are organized in a post/reply style. See the design doc for more details: go/PostRoomsInDynamite. Deprecated. Post rooms are no longer supported.", "Represents an Activity Feed space. These groups are modeled like flat rooms and contain items for users to catch up on important things. Each user should only have one group of this type. See go/activity-feed. LINT.ThenChange(//depot/google3/logs/proto/apps_dynamite/dynamite_visual_element_entry.proto:LoggingGroupType,//depot/google3/java/com/google/apps/dynamite/v1/web/ui/group/groups.js:LoggingGroupType)" ], "type": "string" @@ -4419,7 +4424,7 @@ "type": "object" }, "AppsDynamiteSharedSegmentedMembershipCount": { - "description": "Contains info on membership count for member types: HUMAN_USER, BOT_USER & ROSTER_MEMBER different states: INVITED, JOINED", + "description": "Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED", "id": "AppsDynamiteSharedSegmentedMembershipCount", "properties": { "memberType": { @@ -12926,12 +12931,14 @@ "enum": [ "MESSAGE_STATE_UNSPECIFIED", "MESSAGE_STATE_ACTIVE", - "MESSAGE_STATE_DELETED" + "MESSAGE_STATE_DELETED", + "MESSAGE_STATE_OTR_EDITED" ], "enumDescriptions": [ "", - "", - "" + "The original message is present in storage and not deleted; the message contents can be hydrated.", + "The original message has been deleted; the message contents cannot be hydrated.", + "The OTR original message was edited and therefore no longer retrievable from storage; the message contents cannot be hydrated. See go/message-quoting-otr-edits for more context." ], "readOnly": true, "type": "string" @@ -15523,13 +15530,15 @@ "description": "Describes how updater_count_to_show should be used.", "enum": [ "UPDATER_COUNT_DISPLAY_TYPE_UNSPECIFIED", + "NO_DISPLAY_COUNT", "EXACT_COUNT", "NONZERO_COUNT" ], "enumDescriptions": [ "", - "A precise updater count is known and the value set in updater_count_to_show should be used. If set, updater_count_to_show is set to the total number of updaters minus the one set in updater_to_show.", - "A precise updater count could not be calculated, but there is at least one. Any value set in updater_count_to_show should NOT be used." + "No additional updaters where involved. Shows up in clients as \"$USERNAME replied\".", + "A precise updater count is known and the value set in updater_count_to_show should be used. If set, updater_count_to_show is set to the total number of updaters minus the one set in updater_to_show. Shows up in clients as \"$USERNAME and $NUM others replied\".", + "A precise updater count could not be calculated, but there is at least one. Any value set in updater_count_to_show should NOT be used. Shows up in clients as \"$USERNAME and others replied\"." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudshell.v1.json b/googleapiclient/discovery_cache/documents/cloudshell.v1.json index 7599b44a9b7..4482e07b068 100644 --- a/googleapiclient/discovery_cache/documents/cloudshell.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudshell.v1.json @@ -374,7 +374,7 @@ } } }, - "revision": "20220831", + "revision": "20220912", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index e83be363ed0..8e1718f23cb 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -378,7 +378,7 @@ "type": "string" }, "query": { - "description": "An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. You must specify eitehr `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` retricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`", + "description": "An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify eitehr `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` retricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `billing_account=\"billingAccounts/123456-A0B0C0-CUZ789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`", "location": "query", "type": "string" } @@ -575,7 +575,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index b244ae08b41..d4269ab85d3 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -406,7 +406,7 @@ } } }, - "revision": "20220824", + "revision": "20220909", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index f8c9593873a..75747b6e5c1 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -518,7 +518,7 @@ } } }, - "revision": "20220824", + "revision": "20220909", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 827d6b58019..ab39e5f18fe 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -1047,7 +1047,7 @@ } } }, - "revision": "20220823", + "revision": "20220912", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -1217,7 +1217,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 144d58b14b6..998371d2dc1 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -478,7 +478,7 @@ } } }, - "revision": "20220823", + "revision": "20220912", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 02958522096..827a0083bbf 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2487,7 +2487,7 @@ } } }, - "revision": "20220817", + "revision": "20220826", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2636,7 +2636,7 @@ "description": "Specifies the node management options for NAP created node-pools." }, "minCpuPlatform": { - "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", + "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", "type": "string" }, "oauthScopes": { @@ -3284,6 +3284,10 @@ "description": "The node pool to be upgraded. This field is mandatory if \"desired_node_version\", \"desired_image_family\" or \"desired_node_pool_autoscaling\" is specified and there is more than one node pool on the cluster.", "type": "string" }, + "desiredNodePoolLoggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "The desired node pool logging configuration defaults for the cluster." + }, "desiredNodeVersion": { "description": "The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the Kubernetes master version", "type": "string" @@ -4033,6 +4037,27 @@ }, "type": "object" }, + "LoggingVariantConfig": { + "description": "LoggingVariantConfig specifies the behaviour of the logging component.", + "id": "LoggingVariantConfig", + "properties": { + "variant": { + "description": "Logging variant deployed on nodes.", + "enum": [ + "VARIANT_UNSPECIFIED", + "DEFAULT", + "MAX_THROUGHPUT" + ], + "enumDescriptions": [ + "Default value. This shouldn't be used.", + "default logging variant.", + "maximum logging throughput variant." + ], + "type": "string" + } + }, + "type": "object" + }, "MaintenanceExclusionOptions": { "description": "Represents the Maintenance exclusion option.", "id": "MaintenanceExclusionOptions", @@ -4438,6 +4463,10 @@ "format": "int32", "type": "integer" }, + "loggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "Logging configuration." + }, "machineType": { "description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.", "type": "string" @@ -4516,6 +4545,10 @@ "gcfsConfig": { "$ref": "GcfsConfig", "description": "GCFS (Google Container File System, also known as Riptide) options." + }, + "loggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "Logging configuration for node pools." } }, "type": "object" @@ -4776,6 +4809,17 @@ }, "type": "object" }, + "NodePoolLoggingConfig": { + "description": "NodePoolLoggingConfig specifies logging configuration for nodepools.", + "id": "NodePoolLoggingConfig", + "properties": { + "variantConfig": { + "$ref": "LoggingVariantConfig", + "description": "Logging variant configuration." + } + }, + "type": "object" + }, "NodeTaint": { "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.", "id": "NodeTaint", @@ -5160,7 +5204,7 @@ "type": "string" }, "key": { - "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify \"googleapis.com/reservation-name\" as the key and specify the name of your reservation as its value.", + "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify \"compute.googleapis.com/reservation-name\" as the key and specify the name of your reservation as its value.", "type": "string" }, "values": { @@ -6042,6 +6086,10 @@ }, "type": "array" }, + "loggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "Logging configuration." + }, "name": { "description": "The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 9cf3bb41494..818f644b0d2 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2512,7 +2512,7 @@ } } }, - "revision": "20220817", + "revision": "20220826", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2678,7 +2678,7 @@ "description": "NodeManagement configuration for this NodePool." }, "minCpuPlatform": { - "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", + "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using https://cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", "type": "string" }, "oauthScopes": { @@ -3416,6 +3416,10 @@ "description": "The node pool to be upgraded. This field is mandatory if \"desired_node_version\", \"desired_image_family\", \"desired_node_pool_autoscaling\", or \"desired_workload_metadata_config\" is specified and there is more than one node pool on the cluster.", "type": "string" }, + "desiredNodePoolLoggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "The desired node pool logging configuration defaults for the cluster." + }, "desiredNodeVersion": { "description": "The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the Kubernetes master version", "type": "string" @@ -4380,6 +4384,27 @@ }, "type": "object" }, + "LoggingVariantConfig": { + "description": "LoggingVariantConfig specifies the behaviour of the logging component.", + "id": "LoggingVariantConfig", + "properties": { + "variant": { + "description": "Logging variant deployed on nodes.", + "enum": [ + "VARIANT_UNSPECIFIED", + "DEFAULT", + "MAX_THROUGHPUT" + ], + "enumDescriptions": [ + "Default value. This shouldn't be used.", + "default logging variant.", + "maximum logging throughput variant." + ], + "type": "string" + } + }, + "type": "object" + }, "MaintenanceExclusionOptions": { "description": "Represents the Maintenance exclusion option.", "id": "MaintenanceExclusionOptions", @@ -4808,6 +4833,10 @@ "format": "int32", "type": "integer" }, + "loggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "Logging configuration." + }, "machineType": { "description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.", "type": "string" @@ -4820,7 +4849,7 @@ "type": "object" }, "minCpuPlatform": { - "description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)", + "description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).", "type": "string" }, "nodeGroup": { @@ -4886,6 +4915,10 @@ "gcfsConfig": { "$ref": "GcfsConfig", "description": "GCFS (Google Container File System, also known as Riptide) options." + }, + "loggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "Logging configuration for node pools." } }, "type": "object" @@ -5150,6 +5183,17 @@ }, "type": "object" }, + "NodePoolLoggingConfig": { + "description": "NodePoolLoggingConfig specifies logging configuration for nodepools.", + "id": "NodePoolLoggingConfig", + "properties": { + "variantConfig": { + "$ref": "LoggingVariantConfig", + "description": "Logging variant configuration." + } + }, + "type": "object" + }, "NodeTaint": { "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.", "id": "NodeTaint", @@ -5582,7 +5626,7 @@ "type": "string" }, "key": { - "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify \"googleapis.com/reservation-name\" as the key and specify the name of your reservation as its value.", + "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify \"compute.googleapis.com/reservation-name\" as the key and specify the name of your reservation as its value.", "type": "string" }, "values": { @@ -6494,6 +6538,10 @@ }, "type": "array" }, + "loggingConfig": { + "$ref": "NodePoolLoggingConfig", + "description": "Logging configuration." + }, "name": { "description": "The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index c7bd46776a3..ff8945f2267 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -5908,7 +5908,7 @@ } } }, - "revision": "20220905", + "revision": "20220912", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index ff35b863c8c..ff68c710a1f 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -674,7 +674,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index b2ff768cfef..7d257eae961 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -218,11 +218,6 @@ "location": "query", "type": "string" }, - "name": { - "description": "Optional. The job name. Optional.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.", "format": "int32", @@ -458,11 +453,6 @@ "location": "query", "type": "string" }, - "name": { - "description": "Optional. The job name. Optional.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.", "format": "int32", @@ -1168,11 +1158,6 @@ "required": true, "type": "string" }, - "name": { - "description": "Optional. The job name. Optional.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.", "format": "int32", @@ -2240,7 +2225,7 @@ } } }, - "revision": "20220904", + "revision": "20220916", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -4835,10 +4820,6 @@ "$ref": "TransformSummary" }, "type": "array" - }, - "stepNamesHash": { - "description": "A hash value of the submitted pipeline portable graph step names if exists.", - "type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json b/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json index a7acfef1741..e703e2e0886 100644 --- a/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json @@ -1596,7 +1596,7 @@ } } }, - "revision": "20220621", + "revision": "20220912", "rootUrl": "https://datalabeling.googleapis.com/", "schemas": { "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { diff --git a/googleapiclient/discovery_cache/documents/datapipelines.v1.json b/googleapiclient/discovery_cache/documents/datapipelines.v1.json index 9e995d2a001..771d09fd369 100644 --- a/googleapiclient/discovery_cache/documents/datapipelines.v1.json +++ b/googleapiclient/discovery_cache/documents/datapipelines.v1.json @@ -371,7 +371,7 @@ } } }, - "revision": "20220826", + "revision": "20220904", "rootUrl": "https://datapipelines.googleapis.com/", "schemas": { "GoogleCloudDatapipelinesV1DataflowJobDetails": { diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 1715fcce669..e7ae522004e 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -2444,7 +2444,7 @@ } } }, - "revision": "20220907", + "revision": "20220911", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 510b356cddb..9d6952f49d9 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1217,7 +1217,7 @@ } } }, - "revision": "20220830", + "revision": "20220906", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index 99198e8fca6..c210caa6209 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1588,7 +1588,7 @@ } } }, - "revision": "20220811", + "revision": "20220908", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -1702,7 +1702,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index 373b05fddaa..fd3dcef3635 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -988,7 +988,7 @@ } } }, - "revision": "20220811", + "revision": "20220908", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1048,7 +1048,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json index 69c2a309957..1972c1d2dd3 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1552,7 +1552,7 @@ } } }, - "revision": "20220811", + "revision": "20220908", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -1666,7 +1666,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json index b03083a8704..13648124b3b 100644 --- a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +++ b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json @@ -199,7 +199,7 @@ } } }, - "revision": "20220906", + "revision": "20220913", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": { diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v1.json b/googleapiclient/discovery_cache/documents/displayvideo.v1.json index b9039078342..b320712c489 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v1.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v1.json @@ -8146,7 +8146,7 @@ } } }, - "revision": "20220909", + "revision": "20220916", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json new file mode 100644 index 00000000000..1a7b13f7393 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -0,0 +1,19069 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "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" + } + } + } + }, + "basePath": "", + "baseUrl": "https://displayvideo.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Display Video", + "description": "Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/display-video/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "displayvideo:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://displayvideo.mtls.googleapis.com/", + "name": "displayvideo", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "advertisers": { + "methods": { + "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": "v2/advertisers/{advertisersId}:audit", + "httpMethod": "GET", + "id": "displayvideo.advertisers.audit", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to audit.", + "format": "int64", + "location": "path", + "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": "v2/advertisers/{+advertiserId}:audit", + "response": { + "$ref": "AuditAdvertiserResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.", + "flatPath": "v2/advertisers", + "httpMethod": "POST", + "id": "displayvideo.advertisers.create", + "parameterOrder": [], + "parameters": {}, + "path": "v2/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": "v2/advertisers/{advertisersId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.delete", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser we need to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/advertisers/{advertisersId}:editAssignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.advertisers.editAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}:editAssignedTargetingOptions", + "request": { + "$ref": "BulkEditAdvertiserAssignedTargetingOptionsRequest" + }, + "response": { + "$ref": "BulkEditAdvertiserAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an advertiser.", + "flatPath": "v2/advertisers/{advertisersId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.get", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}", + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "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": "v2/advertisers", + "httpMethod": "GET", + "id": "displayvideo.advertisers.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by advertiser properties. 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 operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. * 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.", + "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 `100`. 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": "v2/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": "v2/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 properties. 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}`. * The operator must be `EQUALS (=)`. * 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.", + "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": "v2/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": "v2/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": "v2/advertisers/{+advertiserId}", + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "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": "v2/advertisers/{advertisersId}/assets", + "httpMethod": "POST", + "id": "displayvideo.advertisers.assets.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v2/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": "v2/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": "v2/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": "v2/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.", + "flatPath": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 properties. 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 operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. * 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.", + "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`.", + "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": "v2/advertisers/{+advertiserId}/campaigns", + "response": { + "$ref": "ListCampaignsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "listAssignedTargetingOptions": { + "description": "Lists assigned targeting options of a campaign across targeting types.", + "flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}:listAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.listAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId", + "campaignId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "Required. The ID of the campaign to list assigned targeting options for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_LANGUAGE or TARGETING_TYPE_GENDER `targetingType=\"TARGETING_TYPE_LANGUAGE\" OR targetingType=\"TARGETING_TYPE_GENDER\"` * AssignedTargetingOptions 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.", + "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 `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions", + "response": { + "$ref": "BulkListCampaignAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing campaign. Returns the updated campaign if successful.", + "flatPath": "v2/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": "v2/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" + ] + } + }, + "resources": { + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "get": { + "description": "Gets a single targeting option assigned to a campaign.", + "flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "advertiserId", + "campaignId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "Required. The ID of the campaign 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: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `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_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the targeting options assigned to a campaign for a specified targeting type.", + "flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "campaignId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "Required. The ID of the campaign to list assigned targeting options for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * AssignedTargetingOptions 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.", + "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 `ListCampaignAssignedTargetingOptions` 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_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `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_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "response": { + "$ref": "ListCampaignAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } + }, + "channels": { + "methods": { + "create": { + "description": "Creates a new channel. Returns the newly created channel if successful.", + "flatPath": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.", + "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 `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 `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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"`", + "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": "v2/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.", + "flatPath": "v2/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": "v2/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.", + "flatPath": "v2/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": "v2/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.", + "flatPath": "v2/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": "v2/advertisers/{+advertiserId}/creatives/{+creativeId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a creative.", + "flatPath": "v2/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": "v2/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": "v2/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 properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)` for the following fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `creativeId` * The operator must be `HAS (:)` for the following fields: - `lineItemIds` * The operator must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` for the following fields: - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic`, there may be at most one restriction. * For `dimensions`, the value is in the form of `\"{width}x{height}\"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `\"{duration}s\"`. Only seconds are supported with millisecond granularity. * 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). * There may be multiple `lineItemIds` restrictions in order to search against multiple possible line item IDs. * There may be multiple `creativeId` restrictions in order to search against multiple possible creative IDs. 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.", + "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 `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 `ListCreatives` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/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.", + "flatPath": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 properties. 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 operator used on `budget.budget_segments.date_range.end_date` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `entityStatus` - `budget.budget_segments.date_range.end_date` (input as YYYY-MM-DD) - `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 whose budget segments' dates end before March 28, 2019: `budget.budget_segments.date_range.end_date<\"2019-03-28\"` * 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.", + "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": "v2/advertisers/{+advertiserId}/insertionOrders", + "response": { + "$ref": "ListInsertionOrdersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "listAssignedTargetingOptions": { + "description": "Lists assigned targeting options of an insertion order across targeting types.", + "flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}:listAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId", + "insertionOrderId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the insertion order belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * AssignedTargetingOptions 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.", + "location": "query", + "type": "string" + }, + "insertionOrderId": { + "description": "Required. The ID of the insertion order 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: * `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 `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions", + "response": { + "$ref": "BulkListInsertionOrderAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing insertion order. Returns the updated insertion order if successful.", + "flatPath": "v2/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": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", + "request": { + "$ref": "InsertionOrder" + }, + "response": { + "$ref": "InsertionOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "get": { + "description": "Gets a single targeting option assigned to an insertion order.", + "flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "advertiserId", + "insertionOrderId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the insertion order belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "insertionOrderId": { + "description": "Required. The ID of the insertion order 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.", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the targeting options assigned to an insertion order.", + "flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "insertionOrderId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the insertion order belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * AssignedTargetingOptions 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.", + "location": "query", + "type": "string" + }, + "insertionOrderId": { + "description": "Required. The ID of the insertion order 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 `ListInsertionOrderAssignedTargetingOptions` 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.", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "response": { + "$ref": "ListInsertionOrderAssignedTargetingOptionsResponse" + }, + "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": "v2/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 `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 `ListInvoices` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/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": "v2/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": "v2/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 .", + "flatPath": "v2/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": "v2/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": "v2/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 properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * AssignedTargetingOptions 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.", + "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": "v2/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions", + "response": { + "$ref": "BulkListAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "bulkUpdate": { + "description": "Updates multiple line items.", + "flatPath": "v2/advertisers/{advertisersId}/lineItems:bulkUpdate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.bulkUpdate", + "parameterOrder": [ + "advertisersId" + ], + "parameters": { + "advertisersId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{advertisersId}/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.", + "flatPath": "v2/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": "v2/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.", + "flatPath": "v2/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": "v2/advertisers/{+advertiserId}/lineItems/{+lineItemId}", + "response": { + "$ref": "Empty" + }, + "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", + "flatPath": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 properties. 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 operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported properties: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) - `targetedChannelId` - `targetedNegativeKeywordListId` 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 whose flight dates end before March 28, 2019: `flight.dateRange.endDate<\"2019-03-28\"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:\"NO_VALID_CREATIVE\"` * 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\"` * All line items that are using both the specified channel and specified negative keyword list in their targeting: `targetedNegativeKeywordListId=789 AND targetedChannelId=12345` The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `flight.dateRange.endDate` * `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 `ListLineItems` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption", + "flatPath": "v2/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": "v2/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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption", + "flatPath": "v2/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.", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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: * BulkEditLineItemAssignedTargetingOptions * UpdateLineItem * CreateLineItemAssignedTargetingOption * DeleteLineItemAssignedTargetingOption", + "flatPath": "v2/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.", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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.", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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 properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * AssignedTargetingOptions 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.", + "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.", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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": "v2/advertisers/{+advertiserId}/locationLists", + "request": { + "$ref": "LocationList" + }, + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a location list.", + "flatPath": "v2/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": "v2/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": "v2/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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"`", + "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 `100`. 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": "v2/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": "v2/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": "v2/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 BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.", + "flatPath": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedLocationId` The length of this field should be no more than 500 characters.", + "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 `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 `ListAssignedLocations` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "response": { + "$ref": "ListAssignedLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "manualTriggers": { + "methods": { + "activate": { + "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.", + "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:activate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.manualTriggers.activate", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the manual trigger belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Required. The ID of the manual trigger to activate.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate", + "request": { + "$ref": "ActivateManualTriggerRequest" + }, + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful.", + "flatPath": "v2/advertisers/{advertisersId}/manualTriggers", + "httpMethod": "POST", + "id": "displayvideo.advertisers.manualTriggers.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/manualTriggers", + "request": { + "$ref": "ManualTrigger" + }, + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "deactivate": { + "description": "Deactivates a manual trigger.", + "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}:deactivate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.manualTriggers.deactivate", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the manual trigger belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Required. The ID of the manual trigger to deactivate.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate", + "request": { + "$ref": "DeactivateManualTriggerRequest" + }, + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a manual trigger.", + "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.manualTriggers.get", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this manual trigger belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Required. The ID of the manual trigger to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}", + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.", + "flatPath": "v2/advertisers/{advertisersId}/manualTriggers", + "httpMethod": "GET", + "id": "displayvideo.advertisers.manualTriggers.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the fetched manual triggers belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by manual trigger properties. 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 operator must be `EQUALS (=)`. * Supported fields: - `displayName` - `state` Examples: * All active manual triggers under an advertiser: `state=\"ACTIVE\"` The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `state` 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 `100`. 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 `ListManualTriggers` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/advertisers/{+advertiserId}/manualTriggers", + "response": { + "$ref": "ListManualTriggersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a manual trigger. Returns the updated manual trigger if successful.", + "flatPath": "v2/advertisers/{advertisersId}/manualTriggers/{manualTriggersId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.manualTriggers.patch", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Output only. The unique ID of the manual trigger.", + "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": "v2/advertisers/{+advertiserId}/manualTriggers/{+triggerId}", + "request": { + "$ref": "ManualTrigger" + }, + "response": { + "$ref": "ManualTrigger" + }, + "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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 `100`. 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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 keyword currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue` Examples: * All negative keywords for which the keyword value contains \"google\": `keywordValue : \"google\"`", + "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": "v2/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": "v2/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": "v2/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": "v2/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`", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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`", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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`", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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 properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters.", + "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`", + "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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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": "v2/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": "v2/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 currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.", + "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 `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 `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": "v2/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": "v2/customBiddingAlgorithms", + "httpMethod": "POST", + "id": "displayvideo.customBiddingAlgorithms.create", + "parameterOrder": [], + "parameters": {}, + "path": "v2/customBiddingAlgorithms", + "request": { + "$ref": "CustomBiddingAlgorithm" + }, + "response": { + "$ref": "CustomBiddingAlgorithm" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a custom bidding algorithm.", + "flatPath": "v2/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": "v2/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": "v2/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 operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following field: - `displayName` * The operator must be `EQUALS (=)` for the following field: - `customBiddingAlgorithmType` * For `displayName`, the value is a string. We return all custom bidding algorithms whose display_name contains such string. * For `customBiddingAlgorithmType`, the value is a string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type. 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.", + "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 `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 `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": "v2/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.", + "flatPath": "v2/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": "v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}", + "request": { + "$ref": "CustomBiddingAlgorithm" + }, + "response": { + "$ref": "CustomBiddingAlgorithm" + }, + "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": "v2/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": "v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript", + "response": { + "$ref": "CustomBiddingScriptRef" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "scripts": { + "methods": { + "create": { + "description": "Creates a new custom bidding script. Returns the newly created script if successful.", + "flatPath": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 `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 `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": "v2/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts", + "response": { + "$ref": "ListCustomBiddingScriptsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "customLists": { + "methods": { + "get": { + "description": "Gets a custom list.", + "flatPath": "v2/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": "v2/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": "v2/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 currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.", + "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 `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 `ListCustomLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/customLists", + "response": { + "$ref": "ListCustomListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "firstAndThirdPartyAudiences": { + "methods": { + "create": { + "description": "Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", + "flatPath": "v2/firstAndThirdPartyAudiences", + "httpMethod": "POST", + "id": "displayvideo.firstAndThirdPartyAudiences.create", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v2/firstAndThirdPartyAudiences", + "request": { + "$ref": "FirstAndThirdPartyAudience" + }, + "response": { + "$ref": "FirstAndThirdPartyAudience" + }, + "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": "v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers", + "httpMethod": "POST", + "id": "displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers", + "parameterOrder": [ + "firstAndThirdPartyAudienceId" + ], + "parameters": { + "firstAndThirdPartyAudienceId": { + "description": "Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers", + "request": { + "$ref": "EditCustomerMatchMembersRequest" + }, + "response": { + "$ref": "EditCustomerMatchMembersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a first and third party audience.", + "flatPath": "v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}", + "httpMethod": "GET", + "id": "displayvideo.firstAndThirdPartyAudiences.get", + "parameterOrder": [ + "firstAndThirdPartyAudienceId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched first and third party audience.", + "format": "int64", + "location": "query", + "type": "string" + }, + "firstAndThirdPartyAudienceId": { + "description": "Required. The ID of the first and third party 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 and third party audience.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}", + "response": { + "$ref": "FirstAndThirdPartyAudience" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists first and third party audiences. The order is defined by the order_by parameter.", + "flatPath": "v2/firstAndThirdPartyAudiences", + "httpMethod": "GET", + "id": "displayvideo.firstAndThirdPartyAudiences.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched first and third party audiences.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "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`.", + "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 `ListFirstAndThirdPartyAudiences` 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 and third party audiences.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v2/firstAndThirdPartyAudiences", + "response": { + "$ref": "ListFirstAndThirdPartyAudiencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", + "flatPath": "v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}", + "httpMethod": "PATCH", + "id": "displayvideo.firstAndThirdPartyAudiences.patch", + "parameterOrder": [ + "firstAndThirdPartyAudienceId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.", + "format": "int64", + "location": "query", + "type": "string" + }, + "firstAndThirdPartyAudienceId": { + "description": "Output only. The unique ID of the first and third party 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": "v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}", + "request": { + "$ref": "FirstAndThirdPartyAudience" + }, + "response": { + "$ref": "FirstAndThirdPartyAudience" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "floodlightGroups": { + "methods": { + "get": { + "description": "Gets a Floodlight group.", + "flatPath": "v2/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": "v2/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": "v2/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": "v2/floodlightGroups/{floodlightGroupId}", + "request": { + "$ref": "FloodlightGroup" + }, + "response": { + "$ref": "FloodlightGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "googleAudiences": { + "methods": { + "get": { + "description": "Gets a Google audience.", + "flatPath": "v2/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": "v2/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": "v2/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 currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.", + "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 `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 `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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors", + "request": { + "$ref": "EditGuaranteedOrderReadAccessorsRequest" + }, + "response": { + "$ref": "EditGuaranteedOrderReadAccessorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a guaranteed order.", + "flatPath": "v2/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": "v2/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": "v2/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 properties. * 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 operator must be `EQUALS (=)`. * 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.", + "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 `100`. If unspecified or greater than `100` 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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/inventorySourceGroups", + "request": { + "$ref": "InventorySourceGroup" + }, + "response": { + "$ref": "InventorySourceGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an inventory source group.", + "flatPath": "v2/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": "v2/inventorySourceGroups/{+inventorySourceGroupId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an inventory source group.", + "flatPath": "v2/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": "v2/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": "v2/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 properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters.", + "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 `100`. 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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedInventorySourceId` The length of this field should be no more than 500 characters.", + "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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors", + "request": { + "$ref": "EditInventorySourceReadWriteAccessorsRequest" + }, + "response": { + "$ref": "InventorySourceAccessors" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an inventory source.", + "flatPath": "v2/inventorySources/{inventorySourcesId}", + "httpMethod": "GET", + "id": "displayvideo.inventorySources.get", + "parameterOrder": [ + "inventorySourceId" + ], + "parameters": { + "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": "v2/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": "v2/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 properties. 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 operator must be `EQUALS (=)`. * 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.", + "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 `100`. 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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/partners/{+partnerId}:editAssignedTargetingOptions", + "request": { + "$ref": "BulkEditPartnerAssignedTargetingOptionsRequest" + }, + "response": { + "$ref": "BulkEditPartnerAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a partner.", + "flatPath": "v2/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": "v2/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": "v2/partners", + "httpMethod": "GET", + "id": "displayvideo.partners.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by partner properties. 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 operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All active partners: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` The length of this field should be no more than 500 characters.", + "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 `100`. 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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * 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.", + "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 `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 `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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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": "v2/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 currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"`", + "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": "v2/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.", + "flatPath": "v2/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": "v2/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": "v2/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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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 properties. 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with ID 123456 `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters.", + "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 `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 `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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/sdfdownloadtasks", + "httpMethod": "POST", + "id": "displayvideo.sdfdownloadtasks.create", + "parameterOrder": [], + "parameters": {}, + "path": "v2/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": "v2/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": "v2/{+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": "v2/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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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 properties. 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}`. * The operator must be \"=\" (equal sign). * 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.", + "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 `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 `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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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": "v2/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" + ], + "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.", + "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." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/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.", + "flatPath": "v2/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": "v2/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.", + "flatPath": "v2/users", + "httpMethod": "POST", + "id": "displayvideo.users.create", + "parameterOrder": [], + "parameters": {}, + "path": "v2/users", + "request": { + "$ref": "User" + }, + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "delete": { + "description": "Deletes a user.", + "flatPath": "v2/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": "v2/users/{+userId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "get": { + "description": "Gets a user.", + "flatPath": "v2/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": "v2/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.", + "flatPath": "v2/users", + "httpMethod": "GET", + "id": "displayvideo.users.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by user properties. 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 operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following fields: - `displayName` - `email` * The operator must be `EQUALS (=)` for the following fields: - `assignedUserRole.userRole` - `assignedUserRole.partnerId` - `assignedUserRole.advertiserId` - `assignedUserRole.entityType`: A 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`: A synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned.\" 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\"` The length of this field should be no more than 500 characters.", + "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 `100`. 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": "v2/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.", + "flatPath": "v2/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": "v2/users/{+userId}", + "request": { + "$ref": "User" + }, + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + } + } + } + }, + "revision": "20220916", + "rootUrl": "https://displayvideo.googleapis.com/", + "schemas": { + "ActivateManualTriggerRequest": { + "description": "Request message for ManualTriggerService.ActivateManualTrigger.", + "id": "ActivateManualTriggerRequest", + "properties": {}, + "type": "object" + }, + "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" + }, + "Adloox": { + "description": "Details of Adloox settings.", + "id": "Adloox", + "properties": { + "excludedAdlooxCategories": { + "description": "Adloox's brand safety settings.", + "items": { + "enum": [ + "ADLOOX_UNSPECIFIED", + "ADULT_CONTENT_HARD", + "ADULT_CONTENT_SOFT", + "ILLEGAL_CONTENT", + "BORDERLINE_CONTENT", + "DISCRIMINATORY_CONTENT", + "VIOLENT_CONTENT_WEAPONS", + "LOW_VIEWABILITY_DOMAINS", + "FRAUD" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any Adloox option.", + "Adult content (hard).", + "Adult content (soft).", + "Illegal content.", + "Borderline content.", + "Discriminatory content.", + "Violent content & weapons.", + "Low viewability domains.", + "Fraud." + ], + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "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" + }, + "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 use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.", + "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": "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. Output only in v1. Required in v2.", + "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" + }, + "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" + ], + "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." + ], + "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.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AssetAssociation": { + "description": "Asset association for the creative.", + "id": "AssetAssociation", + "properties": { + "asset": { + "$ref": "Asset", + "description": "The associated asset." + }, + "role": { + "description": "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" + ], + "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 following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`", + "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. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`", + "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. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`", + "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. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`", + "The icon of a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`", + "The cover image of a native video creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_VIDEO`" + ], + "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. Currently, geo region targeting options are the only supported option for assignment.", + "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. Must be of type TARGETING_TYPE_GEO_REGION.", + "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" + }, + "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." + }, + "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" + ], + "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.", + "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." + ], + "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." + } + }, + "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": { + "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." + }, + "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." + }, + "includedCombinedAudienceGroup": { + "$ref": "CombinedAudienceGroup", + "description": "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." + }, + "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.", + "items": { + "$ref": "FirstAndThirdPartyAudienceGroup" + }, + "type": "array" + }, + "includedGoogleAudienceGroup": { + "$ref": "GoogleAudienceGroup", + "description": "The Google audience ids of the included Google audience group. Contains Google audience ids only." + } + }, + "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": "The audio content type. Output only in v1. Required in v2.", + "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": "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.", + "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`.", + "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 default value and does not represent a real authorized seller status option.", + "Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file.", + "All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers." + ], + "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 default value and does not represent a real authorized seller status option.", + "Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file.", + "All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers." + ], + "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." + } + }, + "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`", + "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`", + "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 AssignedLocations.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + }, + "deletedAssignedLocations": { + "description": "The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedLocationsResponse": { + "description": "Response message for AssignedLocationService.BulkEditAssignedLocations.", + "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.", + "items": { + "$ref": "CreateAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "deleteRequests": { + "description": "The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest.", + "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" + }, + "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" + }, + "BulkListCampaignAssignedTargetingOptionsResponse": { + "description": "Response message for BulkListCampaignAssignedTargetingOptions.", + "id": "BulkListCampaignAssignedTargetingOptionsResponse", + "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 BulkListCampaignAssignedTargetingOptionsRequest 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" + }, + "BulkListInsertionOrderAssignedTargetingOptionsResponse": { + "description": "Response message for BulkListInsertionOrderAssignedTargetingOptions.", + "id": "BulkListInsertionOrderAssignedTargetingOptionsResponse", + "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 BulkListInsertionOrderAssignedTargetingOptionsRequest 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" + }, + "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" + }, + "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" + ], + "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." + ], + "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." + }, + "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" + }, + "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": "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.", + "format": "int64", + "type": "string" + }, + "cmPlacementId": { + "description": "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 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" + }, + "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": { + "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": "The content instream position for video or audio ads. Output only in v1. Required in v2.", + "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": "The content outstream position. Output only in v1. Required in v2.", + "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.", + "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" + ], + "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.", + "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." + ], + "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" + ], + "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" + ], + "type": "string" + } + }, + "type": "object" + }, + "Creative": { + "description": "A single Creative.", + "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_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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": "Third-party HTML tracking tag to be appended to the creative tag.", + "type": "string" + }, + "assets": { + "description": "Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD`", + "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": "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` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`", + "items": { + "format": "int64", + "type": "string" + }, + "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.", + "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" + ], + "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 supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Square native app install creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "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." + ], + "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_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_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_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `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": "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.", + "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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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": "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`" + }, + "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": "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": "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`", + "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": "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.", + "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 supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_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`", + "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" + ], + "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 supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Square native app install creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "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." + ], + "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", + "ADS_DATA_HUB_BASED", + "GOAL_BUILDER_BASED" + ], + "enumDescriptions": [ + "Algorithm type is not specified or is unknown in this version.", + "Algorithm generated through customer-uploaded custom bidding script files.", + "Algorithm created through Ads Data Hub product.", + "Algorithm created through goal builder in DV3 UI." + ], + "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" + }, + "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" + ], + "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`." + ], + "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 Script.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" + }, + "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 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" + }, + "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" + }, + "DeactivateManualTriggerRequest": { + "description": "Request message for ManualTriggerService.DeactivateManualTrigger.", + "id": "DeactivateManualTriggerRequest", + "properties": {}, + "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" + ], + "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.", + "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." + ], + "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": "The display name of the device type. Output only in v1. Required in v2.", + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "DEVICE_TYPE_COMPUTER", + "DEVICE_TYPE_CONNECTED_TV", + "DEVICE_TYPE_SMART_PHONE", + "DEVICE_TYPE_TABLET" + ], + "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.", + "The device type is computer.", + "The device type is connected TV.", + "The device type is smart phone..", + "The device type is tablet." + ], + "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" + ], + "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.", + "The device type is computer.", + "The device type is connected TV.", + "The device type is smart phone..", + "The device type is tablet." + ], + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "EditCustomerMatchMembersResponse": { + "description": "The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", + "id": "EditCustomerMatchMembersResponse", + "properties": { + "firstAndThirdPartyAudienceId": { + "description": "Required. The ID of the updated Customer Match FirstAndThirdPartyAudience.", + "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": "The serving environment. Output only in v1. Required in v2.", + "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. Output only in v1. Required in v2.", + "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" + ], + "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." + ], + "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" + ], + "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." + ], + "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" + ], + "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." + ], + "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" + ], + "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." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ExitEvent": { + "description": "Exit event of the creative.", + "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.", + "type": "string" + }, + "reportingName": { + "description": "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" + }, + "FirstAndThirdPartyAudience": { + "description": "Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.", + "id": "FirstAndThirdPartyAudience", + "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": "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": "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", + "LICENSED" + ], + "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.", + "Subtype of third party audience type." + ], + "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": "The user-provided description of the audience. Only applicable to first party audiences.", + "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": "The display name of the first and third party audience.", + "type": "string" + }, + "firstAndThirdPartyAudienceId": { + "description": "Output only. The unique ID of the first and third party audience. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "firstAndThirdPartyAudienceType": { + "description": "Whether the audience is a first or third party audience.", + "enum": [ + "FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED", + "FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY", + "FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY" + ], + "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." + ], + "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": "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", + "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 and third party 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" + }, + "FirstAndThirdPartyAudienceGroup": { + "description": "Details of first and third party audience group. All first and third party audience targeting settings are logically \u2018OR\u2019 of each other.", + "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.", + "items": { + "$ref": "FirstAndThirdPartyAudienceTargetingSetting" + }, + "type": "array" + } + }, + "type": "object" + }, + "FirstAndThirdPartyAudienceTargetingSetting": { + "description": "Details of first and third party audience targeting setting.", + "id": "FirstAndThirdPartyAudienceTargetingSetting", + "properties": { + "firstAndThirdPartyAudienceId": { + "description": "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.", + "format": "int64", + "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.", + "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" + }, + "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": "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`.", + "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", + "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": "The gender of the audience. Output only in v1. Required in v2.", + "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" + ], + "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." + ], + "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" + ], + "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." + ], + "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" + ], + "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." + ], + "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" + ], + "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 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" + ], + "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." + ], + "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": "The household income of the audience. Output only in v1. Required in v2.", + "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" + }, + "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" + }, + "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" + }, + "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": "The bidding strategy of the insertion order. By default, fixed_bid is set." + }, + "billableOutcome": { + "description": "Immutable. The billable outcome of the insertion order.", + "enum": [ + "BILLABLE_OUTCOME_UNSPECIFIED", + "BILLABLE_OUTCOME_PAY_PER_IMPRESSION", + "BILLABLE_OUTCOME_PAY_PER_CLICK", + "BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION" + ], + "enumDescriptions": [ + "Unspecified billable outcome.", + "Pay per impressions.", + "Pay per click.", + "Pay per active view." + ], + "type": "string" + }, + "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." + }, + "insertionOrderId": { + "description": "Output only. The unique ID of the insertion order. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "insertionOrderType": { + "description": "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": "Additional integration details of the insertion order." + }, + "name": { + "description": "Output only. The resource name of the insertion order.", + "readOnly": true, + "type": "string" + }, + "pacing": { + "$ref": "Pacing", + "description": "Required. The budget spending speed setting of the insertion order." + }, + "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.", + "items": { + "$ref": "PartnerCost" + }, + "type": "array" + }, + "performanceGoal": { + "$ref": "PerformanceGoal", + "description": "Required. Performance goal of the insertion order." + }, + "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": "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 performance_goal. 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 performance_goal." + ], + "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": "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": "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 with a length of no more than 80 characters.", + "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`, 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" + }, + "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" + ], + "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." + ], + "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." + }, + "subSitePropertyId": { + "description": "Immutable. The unique ID of the sub-site property assigned to this inventory source.", + "format": "int64", + "type": "string" + }, + "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" + }, + "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." + }, + "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." + }, + "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" + ], + "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." + ], + "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 [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item." + }, + "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" + }, + "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" + }, + "ListCampaignAssignedTargetingOptionsResponse": { + "description": "Response message for ListCampaignAssignedTargetingOptions.", + "id": "ListCampaignAssignedTargetingOptionsResponse", + "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 ListCampaignAssignedTargetingOptionsRequest 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" + }, + "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" + }, + "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" + }, + "ListFirstAndThirdPartyAudiencesResponse": { + "id": "ListFirstAndThirdPartyAudiencesResponse", + "properties": { + "firstAndThirdPartyAudiences": { + "description": "The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty.", + "items": { + "$ref": "FirstAndThirdPartyAudience" + }, + "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 `ListFirstAndThirdPartyAudiences` 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" + }, + "ListInsertionOrderAssignedTargetingOptionsResponse": { + "description": "Response message for ListInsertionOrderAssignedTargetingOptions.", + "id": "ListInsertionOrderAssignedTargetingOptionsResponse", + "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 ListInsertionOrderAssignedTargetingOptionsRequest 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" + }, + "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" + }, + "ListManualTriggersResponse": { + "id": "ListManualTriggersResponse", + "properties": { + "manualTriggers": { + "description": "The list of manual triggers. This list will be absent if empty.", + "items": { + "$ref": "ManualTrigger" + }, + "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 `ListManualTriggers` 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" + }, + "ManualTrigger": { + "description": "A single manual trigger in Display & Video 360.", + "id": "ManualTrigger", + "properties": { + "activationDurationMinutes": { + "description": "Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "latestActivationTime": { + "description": "Output only. The timestamp of the trigger's latest activation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the manual trigger.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.", + "enum": [ + "STATE_UNSPECIFIED", + "INACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "Default value when state is not specified or is unknown in this version.", + "The trigger is currently inactive and ready to be activated.", + "The trigger is currently active (activated)." + ], + "readOnly": true, + "type": "string" + }, + "triggerId": { + "description": "Output only. The unique ID of the manual trigger.", + "format": "int64", + "readOnly": true, + "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`.", + "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": { + "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": "The content position. Output only in v1. Required in v2.", + "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" + }, + "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": "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": "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": "The program of the OBA icon. For example: \u201cAdChoices\u201d.", + "type": "string" + }, + "resourceMimeType": { + "description": "The MIME type of the OBA icon resource.", + "type": "string" + }, + "resourceUrl": { + "description": "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": "The type of Open Measurement enabled inventory. Output only in v1. Required in v2.", + "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 response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "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 auto_budget_allocation, 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.", + "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" + ], + "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." + ], + "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_AD_GROUP`, 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_AD_GROUP`, 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": "The parental status of the audience. Output only in v1. Required in v2.", + "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." + }, + "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" + }, + "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" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The cost is charged for using Adloox.", + "The cost is charged for using Adloox Pre-Bid.", + "The cost is charged for using AdSafe.", + "The cost is charged for using AdExpose.", + "The cost is charged for using Aggregate Knowledge.", + "The cost is charged for using an Agency Trading Desk.", + "The cost is charged for using DV360.", + "The cost is charged for using comScore vCE.", + "The cost is charged for using a Data Management Platform.", + "The default cost type.", + "The cost is charged for using DoubleVerify.", + "The cost is charged for using DoubleVerify Pre-Bid.", + "The cost is charged for using Evidon.", + "The cost is charged for using Integral Ad Science Video.", + "The cost is charged for using Integral Ad Science Pre-Bid.", + "The cost is charged for using media cost data.", + "The cost is charged for using MOAT Video.", + "The cost is charged for using Nielsen Digital Ad Ratings.", + "The cost is charged for using ShopLocal.", + "The cost is charged for using Teracent.", + "The cost is charged for using a third-party ad server.", + "The cost is charged for using TrustMetrics.", + "The cost is charged for using Vizu.", + "The cost is charged for using AdLingo.", + "The cost is charged as custom fee 1.", + "The cost is charged as custom fee 2.", + "The cost is charged as custom fee 3.", + "The cost is charged as custom fee 4.", + "The cost is charged as custom fee 5." + ], + "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" + ], + "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 or insertion order.", + "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_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 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`.", + "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 SearchTargetingOptions. 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\".", + "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" + }, + "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" + }, + "PublisherReviewStatus": { + "description": "Publisher review status for the creative.", + "id": "PublisherReviewStatus", + "properties": { + "publisherName": { + "description": "The publisher reviewing the creative.", + "type": "string" + }, + "status": { + "description": "Status of the publisher 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" + }, + "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" + }, + "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" + }, + "publisherReviewStatuses": { + "description": "Publisher review statuses for the creative.", + "items": { + "$ref": "PublisherReviewStatus" + }, + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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 `100`. 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. Only applicable to YouTube and Partners line items.", + "Video of live events streamed over the internet. Only applicable to YouTube and Partners line items." + ], + "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. Only applicable to YouTube and Partners line items.", + "Video of live events streamed over the internet. Only applicable to YouTube and Partners line items." + ], + "readOnly": true, + "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" + }, + "TargetingExpansionConfig": { + "description": "Settings that control the targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level.", + "id": "TargetingExpansionConfig", + "properties": { + "excludeFirstPartyAudience": { + "description": "Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.", + "type": "boolean" + }, + "targetingExpansionLevel": { + "description": "Required. Magnitude of expansion for applicable targeting under this line item.", + "enum": [ + "TARGETING_EXPANSION_LEVEL_UNSPECIFIED", + "NO_EXPANSION", + "LEAST_EXPANSION", + "SOME_EXPANSION", + "BALANCED_EXPANSION", + "MORE_EXPANSION", + "MOST_EXPANSION" + ], + "enumDescriptions": [ + "Targeting expansion level is not specified or is unknown in this version.", + "Targeting expansion off.", + "Conservative targeting expansion, lowest reach.", + "Moderately conservative targeting expansion, lower reach.", + "Moderate targeting expansion, medium reach.", + "Moderately aggressive targeting expansion, higher reach.", + "Aggressive targeting expansion, highest reach." + ], + "type": "string" + } + }, + "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" + ], + "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.", + "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." + ], + "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" + }, + "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": "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": "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": "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.", + "format": "int64", + "type": "string" + }, + "bitRateKbps": { + "description": "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." + }, + "fileSizeBytes": { + "description": "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.", + "format": "float", + "type": "number" + }, + "mimeType": { + "description": "The MIME type of the transcoded file.", + "type": "string" + }, + "name": { + "description": "The name of the transcoded file.", + "type": "string" + }, + "transcoded": { + "description": "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": "The unique creative identifier.", + "type": "string" + }, + "registry": { + "description": "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" + }, + "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" + }, + "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": "The video player size. Output only in v1. Required in v2.", + "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": "The predicted viewability percentage. Output only in v1. Required in v2.", + "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": { + "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_MAXIMIZE_LIFT", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS" + ], + "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.", + "An automated bidding strategy that sets bids to achieve maximum lift.", + "A bidding strategy that automatically maximizes number of conversions given a daily 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` 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` 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": { + "includeYoutubeSearch": { + "description": "Whether to target inventory on the YouTube search results page.", + "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" + }, + "includeYoutubeVideos": { + "description": "Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites.", + "type": "boolean" + } + }, + "type": "object" + }, + "YoutubeAndPartnersSettings": { + "description": "Settings for YouTube and Partners line items.", + "id": "YoutubeAndPartnersSettings", + "properties": { + "biddingStrategy": { + "$ref": "YoutubeAndPartnersBiddingStrategy", + "description": "The bidding strategy of the YouTube and Partners line item." + }, + "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" + }, + "inventorySourceSettings": { + "$ref": "YoutubeAndPartnersInventorySourceConfig", + "description": "Settings that control what YouTube and Partners inventories the line item will target." + }, + "thirdPartyMeasurementSettings": { + "$ref": "YoutubeAndPartnersThirdPartyMeasurementSettings", + "description": "The third-party measurement settings of the line item." + }, + "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." + } + }, + "type": "object" + }, + "YoutubeAndPartnersThirdPartyMeasurementSettings": { + "description": "Settings that control what third-party vendors are measuring specific line item metrics.", + "id": "YoutubeAndPartnersThirdPartyMeasurementSettings", + "properties": { + "brandLiftVendorConfigs": { + "description": "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": "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": "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": "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" + } + }, + "servicePath": "", + "title": "Display & Video 360 API", + "version": "v2", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 39d0d56f161..24531dde8da 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -3412,7 +3412,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5762,11 +5762,6 @@ "description": "The infoType details for this column.", "id": "GooglePrivacyDlpV2InfoTypeSummary", "properties": { - "estimatedPrevalence": { - "description": "Approximate percentage of non-null rows that contained data detected by this infotype.", - "format": "int32", - "type": "integer" - }, "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", "description": "The infoType." @@ -7877,7 +7872,7 @@ "type": "string" }, "rowCount": { - "description": "Number of rows in the table when the profile was generated.", + "description": "Number of rows in the table when the profile was generated. This will not be populated for BigLake tables.", "format": "int64", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 525893386e3..0ac1c009c9d 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20220830", + "revision": "20220915", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index 488f1791a67..8ec9272c2f9 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1069,7 +1069,7 @@ } } }, - "revision": "20220901", + "revision": "20220916", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -3162,6 +3162,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1DocumentStyleFontSize", "description": "Font size." @@ -4954,6 +4958,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize", "description": "Font size." @@ -6208,6 +6216,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize", "description": "Font size." diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json index e37de06a901..2a23093885d 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json @@ -292,7 +292,7 @@ } } }, - "revision": "20220901", + "revision": "20220916", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -2378,6 +2378,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize", "description": "Font size." @@ -3657,6 +3661,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize", "description": "Font size." diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 5b9272445b3..1afd191bf65 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -836,7 +836,7 @@ } } }, - "revision": "20220901", + "revision": "20220916", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -2922,6 +2922,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize", "description": "Font size." @@ -4176,6 +4180,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize", "description": "Font size." @@ -5820,6 +5828,10 @@ "$ref": "GoogleTypeColor", "description": "Text color." }, + "fontFamily": { + "description": "Font family such as \"Arial\", \"Times New Roman\". https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, "fontSize": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentStyleFontSize", "description": "Font size." diff --git a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json index 22ec652f97b..874977e77f5 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, - "revision": "20220912", + "revision": "20220917", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json index c6e46b652a6..ba61d9e08ca 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20220830", + "revision": "20220906", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json index a8a6434c5c1..5fbeedc5457 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json @@ -320,7 +320,7 @@ } } }, - "revision": "20220830", + "revision": "20220906", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { diff --git a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json index 9bab6d629bc..30e76e7948e 100644 --- a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json @@ -434,7 +434,7 @@ } } }, - "revision": "20220908", + "revision": "20220913", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index caa47046c05..d463d199f1c 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -38,7 +38,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/OTvf3t04BhXHFGpHCHTdlbn3s9A\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/CfJsi64y9KnCVyLiUeJMMWWz9jo\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -3668,7 +3668,7 @@ } } }, - "revision": "20220905", + "revision": "20220908", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 34601d06535..4cc637d4315 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -35,7 +35,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/3RrrzNEFUtGBkvk7Q4bTHH-tnp4\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/oijYyH_5V0dom-WQpUcjA89Zz1s\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -2312,7 +2312,7 @@ } } }, - "revision": "20220905", + "revision": "20220908", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index 236e67cb856..e928975f5dd 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, - "revision": "20220906", + "revision": "20220913", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2.json b/googleapiclient/discovery_cache/documents/drivelabels.v2.json index 01a78d2a47d..3b7bc0bef8a 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2.json @@ -217,7 +217,7 @@ } } }, - "revision": "20220907", + "revision": "20220914", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2BadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json index 34665b967db..edde48fc17a 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json @@ -888,7 +888,7 @@ } } }, - "revision": "20220907", + "revision": "20220914", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2betaBadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index f8d022b8220..60887f07be5 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json b/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json index a5b1f218b12..bf90dcacb2d 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json @@ -584,7 +584,7 @@ } } }, - "revision": "20220826", + "revision": "20220909", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json index d1ccae78c05..2e368a73f4f 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -304,7 +304,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index 2dc27f949a2..447682fbdc9 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20220829", + "revision": "20220912", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index c5ebdffd003..5c817baeaec 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json index cae5aaf8315..d255a76a1af 100644 --- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json @@ -1320,7 +1320,7 @@ } } }, - "revision": "20220909", + "revision": "20220916", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json index 0f4cb6bab0b..9a2d39a6bb8 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json @@ -1338,7 +1338,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 01b17ad7b57..b4e6237eae6 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -1464,7 +1464,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index e471f97c222..596b1632e21 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -351,7 +351,7 @@ } } }, - "revision": "20220909", + "revision": "20220915", "rootUrl": "https://firebasedatabase.googleapis.com/", "schemas": { "DatabaseInstance": { diff --git a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json index 92a825ac7fc..e747916f3bf 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, - "revision": "20220910", + "revision": "20220914", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json index ab573041e49..90039fafe68 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -186,7 +186,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json index 6170c607672..ff3014ab884 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -1939,7 +1939,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index 97c53ee11d1..9e9223ec8f1 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -204,7 +204,7 @@ } } }, - "revision": "20220907", + "revision": "20220914", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json index 9fa19f14b90..62aa5724484 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json @@ -318,7 +318,7 @@ } } }, - "revision": "20220907", + "revision": "20220914", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "DownloadModelResponse": { diff --git a/googleapiclient/discovery_cache/documents/firebaserules.v1.json b/googleapiclient/discovery_cache/documents/firebaserules.v1.json index f9d8c18511e..1eedb790bde 100644 --- a/googleapiclient/discovery_cache/documents/firebaserules.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaserules.v1.json @@ -477,7 +477,7 @@ } } }, - "revision": "20220825", + "revision": "20220904", "rootUrl": "https://firebaserules.googleapis.com/", "schemas": { "Arg": { diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json index 8e5b641fb18..d6ca23f6d08 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -831,7 +831,7 @@ } } }, - "revision": "20220907", + "revision": "20220913", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json index 05c89484d84..ae419ff37e0 100644 --- a/googleapiclient/discovery_cache/documents/forms.v1.json +++ b/googleapiclient/discovery_cache/documents/forms.v1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20220908", + "revision": "20220915", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/games.v1.json b/googleapiclient/discovery_cache/documents/games.v1.json index 6e258adf2ba..6393b716f96 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -1244,7 +1244,7 @@ } } }, - "revision": "20220831", + "revision": "20220909", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { diff --git a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json index 9299034f0f8..031e976de89 100644 --- a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +++ b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json @@ -439,7 +439,7 @@ } } }, - "revision": "20220831", + "revision": "20220909", "rootUrl": "https://gamesconfiguration.googleapis.com/", "schemas": { "AchievementConfiguration": { diff --git a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json index eac309192cc..8c4e2628ca3 100644 --- a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +++ b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json @@ -471,7 +471,7 @@ } } }, - "revision": "20220831", + "revision": "20220909", "rootUrl": "https://gamesmanagement.googleapis.com/", "schemas": { "AchievementResetAllResponse": { diff --git a/googleapiclient/discovery_cache/documents/gameservices.v1beta.json b/googleapiclient/discovery_cache/documents/gameservices.v1beta.json index b87e918d981..fb6437a9a2d 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1beta.json @@ -401,7 +401,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json index 1851f9cde20..1fad010ba08 100644 --- a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json @@ -301,7 +301,7 @@ } } }, - "revision": "20220829", + "revision": "20220913", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "Accelerator": { @@ -681,7 +681,7 @@ "DATA_LOSS" ], "enumDescriptions": [ - "Not an error; returned on success HTTP Mapping: 200 OK", + "Not an error; returned on success. HTTP Mapping: 200 OK", "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 73af0131f45..d809c6117e0 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -905,7 +905,7 @@ } } }, - "revision": "20220828", + "revision": "20220912", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosVMMembershipSpec": { @@ -1159,6 +1159,10 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "allowVerticalScale": { + "description": "Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling.", + "type": "boolean" + }, "enabled": { "description": "Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field.", "type": "boolean" @@ -2923,6 +2927,44 @@ }, "type": "object" }, + "ServiceMeshDataPlaneManagement": { + "description": "Status of data plane management. Only reported per-member.", + "id": "ServiceMeshDataPlaneManagement", + "properties": { + "details": { + "description": "Explanation of the status.", + "items": { + "$ref": "ServiceMeshStatusDetails" + }, + "type": "array" + }, + "state": { + "description": "Lifecycle status of data plane management.", + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "DISABLED", + "FAILED_PRECONDITION", + "PROVISIONING", + "ACTIVE", + "STALLED", + "NEEDS_ATTENTION", + "DEGRADED" + ], + "enumDescriptions": [ + "Unspecified", + "DISABLED means that the component is not enabled.", + "FAILED_PRECONDITION means that provisioning cannot proceed because of some characteristic of the member cluster.", + "PROVISIONING means that provisioning is in progress.", + "ACTIVE means that the component is ready for use.", + "STALLED means that provisioning could not be done.", + "NEEDS_ATTENTION means that the component is ready, but some user intervention is required. (For example that the user should migrate workloads to a new control plane revision.)", + "DEGRADED means that the component is ready, but operating in a degraded state." + ], + "type": "string" + } + }, + "type": "object" + }, "ServiceMeshMembershipSpec": { "description": "**Service Mesh**: Spec for a single Membership for the servicemesh feature", "id": "ServiceMeshMembershipSpec", @@ -2940,6 +2982,20 @@ "User will manually configure the control plane (e.g. via CLI, or via the ControlPlaneRevision KRM API)" ], "type": "string" + }, + "management": { + "description": "Enables automatic Service Mesh management.", + "enum": [ + "MANAGEMENT_UNSPECIFIED", + "MANAGEMENT_AUTOMATIC", + "MANAGEMENT_MANUAL" + ], + "enumDescriptions": [ + "Unspecified", + "Google should manage my Service Mesh for the cluster.", + "User will manually configure their service mesh components." + ], + "type": "string" } }, "type": "object" @@ -2952,6 +3008,11 @@ "$ref": "ServiceMeshControlPlaneManagement", "description": "Output only. Status of control plane management", "readOnly": true + }, + "dataPlaneManagement": { + "$ref": "ServiceMeshDataPlaneManagement", + "description": "Output only. Status of data plane management.", + "readOnly": true } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 57f7a7b2622..b959a502df4 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -1020,6 +1020,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "validateCreate": { + "description": "ValidateCreateMembership is a preflight check for CreateMembership. It checks the following: 1. Caller has the required `gkehub.memberships.create` permission. 2. The membership_id is still available.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/memberships:validateCreate", + "httpMethod": "POST", + "id": "gkehub.projects.locations.memberships.validateCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/memberships:validateCreate", + "request": { + "$ref": "ValidateCreateMembershipRequest" + }, + "response": { + "$ref": "ValidateCreateMembershipResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1151,7 +1179,7 @@ } } }, - "revision": "20220828", + "revision": "20220912", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -1539,6 +1567,10 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "allowVerticalScale": { + "description": "Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling.", + "type": "boolean" + }, "enabled": { "description": "Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field.", "type": "boolean" @@ -3858,6 +3890,20 @@ "STABLE channel includes versions that are known to be stable and reliable in production." ], "type": "string" + }, + "management": { + "description": "Enables automatic Service Mesh management.", + "enum": [ + "MANAGEMENT_UNSPECIFIED", + "MANAGEMENT_AUTOMATIC", + "MANAGEMENT_MANUAL" + ], + "enumDescriptions": [ + "Unspecified", + "Google should manage my Service Mesh for the cluster.", + "User will manually configure their service mesh components." + ], + "type": "string" } }, "type": "object" @@ -4018,6 +4064,64 @@ } }, "type": "object" + }, + "ValidateCreateMembershipRequest": { + "description": "Request message for the `GkeHub.ValidateCreateMembership` method.", + "id": "ValidateCreateMembershipRequest", + "properties": { + "membership": { + "$ref": "Membership", + "description": "Required. Membership resource to be created." + }, + "membershipId": { + "description": "Required. Client chosen membership id.", + "type": "string" + } + }, + "type": "object" + }, + "ValidateCreateMembershipResponse": { + "description": "Response message for the `GkeHub.ValidateCreateMembership` method.", + "id": "ValidateCreateMembershipResponse", + "properties": { + "validationResults": { + "description": "Wraps all the validator results.", + "items": { + "$ref": "ValidationResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "ValidationResult": { + "description": "ValidationResults are results set by each validator running during ValidateCreateMembership.", + "id": "ValidationResult", + "properties": { + "result": { + "description": "Additional information for the validation.", + "type": "string" + }, + "success": { + "description": "Whether the validation is passed or not.", + "type": "boolean" + }, + "validator": { + "description": "Validator type to validate membership with.", + "enum": [ + "VALIDATOR_TYPE_UNSPECIFIED", + "MEMBERSHIP_ID", + "CROSS_PROJECT_PERMISSION" + ], + "enumDescriptions": [ + "UNSPECIFIED validator.", + "MEMBERSHIP_ID validator validates the membership_id is still available.", + "CROSS_PROJECT_PERMISSION validator validates the cross-project P4SA binding is in place." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json index 613a19a4e74..f2087cdbc9c 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json @@ -652,7 +652,7 @@ } } }, - "revision": "20220828", + "revision": "20220912", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 48dfd8fb040..b9086a0dd57 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -670,7 +670,7 @@ } } }, - "revision": "20220828", + "revision": "20220912", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -970,6 +970,10 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "allowVerticalScale": { + "description": "Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling.", + "type": "boolean" + }, "enabled": { "description": "Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field.", "type": "boolean" @@ -2629,6 +2633,44 @@ }, "type": "object" }, + "ServiceMeshDataPlaneManagement": { + "description": "Status of data plane management. Only reported per-member.", + "id": "ServiceMeshDataPlaneManagement", + "properties": { + "details": { + "description": "Explanation of the status.", + "items": { + "$ref": "ServiceMeshStatusDetails" + }, + "type": "array" + }, + "state": { + "description": "Lifecycle status of data plane management.", + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "DISABLED", + "FAILED_PRECONDITION", + "PROVISIONING", + "ACTIVE", + "STALLED", + "NEEDS_ATTENTION", + "DEGRADED" + ], + "enumDescriptions": [ + "Unspecified", + "DISABLED means that the component is not enabled.", + "FAILED_PRECONDITION means that provisioning cannot proceed because of some characteristic of the member cluster.", + "PROVISIONING means that provisioning is in progress.", + "ACTIVE means that the component is ready for use.", + "STALLED means that provisioning could not be done.", + "NEEDS_ATTENTION means that the component is ready, but some user intervention is required. (For example that the user should migrate workloads to a new control plane revision.)", + "DEGRADED means that the component is ready, but operating in a degraded state." + ], + "type": "string" + } + }, + "type": "object" + }, "ServiceMeshMembershipSpec": { "description": "**Service Mesh**: Spec for a single Membership for the servicemesh feature", "id": "ServiceMeshMembershipSpec", @@ -2646,6 +2688,20 @@ "User will manually configure the control plane (e.g. via CLI, or via the ControlPlaneRevision KRM API)" ], "type": "string" + }, + "management": { + "description": "Enables automatic Service Mesh management.", + "enum": [ + "MANAGEMENT_UNSPECIFIED", + "MANAGEMENT_AUTOMATIC", + "MANAGEMENT_MANUAL" + ], + "enumDescriptions": [ + "Unspecified", + "Google should manage my Service Mesh for the cluster.", + "User will manually configure their service mesh components." + ], + "type": "string" } }, "type": "object" @@ -2658,6 +2714,11 @@ "$ref": "ServiceMeshControlPlaneManagement", "description": "Output only. Status of control plane management", "readOnly": true + }, + "dataPlaneManagement": { + "$ref": "ServiceMeshDataPlaneManagement", + "description": "Output only. Status of data plane management.", + "readOnly": true } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index 4514ee5b84e..d5059ac75d0 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -706,7 +706,7 @@ } } }, - "revision": "20220828", + "revision": "20220912", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index 3cf77082898..48a1d90502e 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -280,7 +280,7 @@ } } }, - "revision": "20220828", + "revision": "20220912", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json index 387df03e725..d97badcfc28 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json index 85f162d4a26..83ab675c4e5 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json index 244f1d4ebec..3123423b479 100644 --- a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20220818", + "revision": "20220908", "rootUrl": "https://groupsmigration.googleapis.com/", "schemas": { "Groups": { diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index 71de7badc5d..a0def975b10 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20220823", + "revision": "20220909", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 6a215caeaec..779177a9b46 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -1921,7 +1921,7 @@ } } }, - "revision": "20220831", + "revision": "20220908", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AdminAuditData": { diff --git a/googleapiclient/discovery_cache/documents/iam.v2beta.json b/googleapiclient/discovery_cache/documents/iam.v2beta.json index 00f4b1794e5..4bfaa4da27f 100644 --- a/googleapiclient/discovery_cache/documents/iam.v2beta.json +++ b/googleapiclient/discovery_cache/documents/iam.v2beta.json @@ -293,7 +293,7 @@ } } }, - "revision": "20220831", + "revision": "20220908", "rootUrl": "https://iam.googleapis.com/", "schemas": { "GoogleIamAdminV1AuditData": { diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index f535978c341..307ae5c563f 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -226,7 +226,7 @@ } } }, - "revision": "20220902", + "revision": "20220909", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json index 9c86fd3172e..aed559b5ca2 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1.json @@ -652,7 +652,7 @@ } } }, - "revision": "20220901", + "revision": "20220912", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1beta1.json b/googleapiclient/discovery_cache/documents/iap.v1beta1.json index e0fda7ea504..f80878e0df6 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1beta1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20220901", + "revision": "20220912", "rootUrl": "https://iap.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json b/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json index 2209d731d68..e5860ae30bf 100644 --- a/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json @@ -331,7 +331,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://ideahub.googleapis.com/", "schemas": { "GoogleSearchIdeahubV1alphaAvailableLocale": { diff --git a/googleapiclient/discovery_cache/documents/ideahub.v1beta.json b/googleapiclient/discovery_cache/documents/ideahub.v1beta.json index bdfe9668138..e9208c02579 100644 --- a/googleapiclient/discovery_cache/documents/ideahub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ideahub.v1beta.json @@ -288,7 +288,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://ideahub.googleapis.com/", "schemas": { "GoogleSearchIdeahubV1betaAvailableLocale": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json index 6d7a7d9419e..96b13b08211 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json @@ -1237,7 +1237,7 @@ } } }, - "revision": "20220902", + "revision": "20220910", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json index 35cc8707861..ac58e9a86b6 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json @@ -1559,7 +1559,7 @@ } } }, - "revision": "20220902", + "revision": "20220910", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2Anonymous": { @@ -2604,6 +2604,10 @@ "$ref": "GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig", "description": "The tenant-level configuration of MFA options." }, + "monitoring": { + "$ref": "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig", + "description": "Configuration related to monitoring project activity." + }, "name": { "description": "Output only. Resource name of a tenant. For example: \"projects/{project-id}/tenants/{tenant-id}\"", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/ids.v1.json b/googleapiclient/discovery_cache/documents/ids.v1.json index 7030054a75c..ef01c274a35 100644 --- a/googleapiclient/discovery_cache/documents/ids.v1.json +++ b/googleapiclient/discovery_cache/documents/ids.v1.json @@ -535,7 +535,7 @@ } } }, - "revision": "20220828", + "revision": "20220831", "rootUrl": "https://ids.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/indexing.v3.json b/googleapiclient/discovery_cache/documents/indexing.v3.json index 4c422ea59f0..7cb554f82c1 100644 --- a/googleapiclient/discovery_cache/documents/indexing.v3.json +++ b/googleapiclient/discovery_cache/documents/indexing.v3.json @@ -149,7 +149,7 @@ } } }, - "revision": "20220815", + "revision": "20220914", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v1alpha.json b/googleapiclient/discovery_cache/documents/integrations.v1alpha.json new file mode 100644 index 00000000000..d54fb26cd74 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/integrations.v1alpha.json @@ -0,0 +1,11238 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://integrations.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Integrations", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "http://www.google.com", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "integrations:v1alpha", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://integrations.mtls.googleapis.com/", + "name": "integrations", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "callback": { + "methods": { + "generateToken": { + "description": "Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.", + "flatPath": "v1alpha/callback:generateToken", + "httpMethod": "GET", + "id": "integrations.callback.generateToken", + "parameterOrder": [], + "parameters": { + "code": { + "description": "The auth code for the given request", + "location": "query", + "type": "string" + }, + "gcpProjectId": { + "description": "The gcp project id of the request", + "location": "query", + "type": "string" + }, + "product": { + "description": "Which product sends the request", + "enum": [ + "UNSPECIFIED_PRODUCT", + "IP", + "APIGEE", + "SECURITY" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "redirectUri": { + "description": "Redirect uri of the auth code request", + "location": "query", + "type": "string" + }, + "state": { + "description": "The auth config id for the given request", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/callback:generateToken", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaGenerateTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "connectorPlatformRegions": { + "methods": { + "enumerate": { + "description": "Enumerates the regions for which Connector Platform is provisioned.", + "flatPath": "v1alpha/connectorPlatformRegions:enumerate", + "httpMethod": "GET", + "id": "integrations.connectorPlatformRegions.enumerate", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha/connectorPlatformRegions:enumerate", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "projects": { + "resources": { + "locations": { + "methods": { + "listTaskEntities": { + "description": "This is a UI only method and will be moved away. Returns a list of common tasks.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:listTaskEntities", + "httpMethod": "GET", + "id": "integrations.projects.locations.listTaskEntities", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location resource of the request. This is not going to be used but preserve the field for future.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:listTaskEntities", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "appsScriptProjects": { + "methods": { + "create": { + "description": "Creates an Apps Script project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects", + "httpMethod": "POST", + "id": "integrations.projects.locations.appsScriptProjects.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project that the executed integration belongs to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/appsScriptProjects", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "link": { + "description": "Links a existing Apps Script project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link", + "httpMethod": "POST", + "id": "integrations.projects.locations.appsScriptProjects.link", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project that the executed integration belongs to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/appsScriptProjects:link", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "authConfigs": { + "methods": { + "create": { + "description": "Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs", + "httpMethod": "POST", + "id": "integrations.projects.locations.authConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "clientCertificate.encryptedPrivateKey": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "clientCertificate.passphrase": { + "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", + "location": "query", + "type": "string" + }, + "clientCertificate.sslCertificate": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. \"projects/{project}/locations/{location}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/authConfigs", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.authConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the AuthConfig.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.authConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the AuthConfig.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs", + "httpMethod": "GET", + "id": "integrations.projects.locations.authConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The size of entries in the response. If unspecified, defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The client, which owns this collection of AuthConfigs.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "The mask which specifies fields that need to be returned in the AuthConfig's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/authConfigs", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.authConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "clientCertificate.encryptedPrivateKey": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "clientCertificate.passphrase": { + "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", + "location": "query", + "type": "string" + }, + "clientCertificate.sslCertificate": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "name": { + "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "certificates": { + "methods": { + "get": { + "description": "Get a certificates in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.certificates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCertificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "connections": { + "methods": { + "getConnectionSchemaMetadata": { + "description": "Lists the available entities and actions associated with a Connection.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata", + "httpMethod": "GET", + "id": "integrations.projects.locations.connections.getConnectionSchemaMetadata", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Connections in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/connections", + "httpMethod": "GET", + "id": "integrations.projects.locations.connections.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by parameters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the Connection, of the form: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/connections", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListConnectionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "runtimeActionSchemas": { + "methods": { + "list": { + "description": "Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas", + "httpMethod": "GET", + "id": "integrations.projects.locations.connections.runtimeActionSchemas.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter. Only the action field with literal equality operator is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/runtimeActionSchemas", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "runtimeEntitySchemas": { + "methods": { + "list": { + "description": "Lists the JSON schemas for the properties of runtime entities, filtered by entity name.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas", + "httpMethod": "GET", + "id": "integrations.projects.locations.connections.runtimeEntitySchemas.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter. Only the entity field with literal equality operator is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/runtimeEntitySchemas", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "integrations": { + "methods": { + "execute": { + "description": "Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.execute", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The integration resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:execute", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of all integrations in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \">\" (greater), \"<\" (less than), >=\" (greater than or equal to), \"<=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "The results would be returned in order you specified here. Supported sort keys are: Descending sort order by \"last_modified_time\", \"created_time\", \"snapshot_number\". Ascending sort order by the integration name.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The page size for the resquest.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token for the resquest.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Project and location from which the integrations should be listed. Format: projects/{project}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/integrations", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "monitorexecutionstats": { + "description": "Get execution stats", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:monitorexecutionstats", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.monitorexecutionstats", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name: {parent=projects/*/locations/*}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:monitorexecutionstats", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "schedule": { + "description": "Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.schedule", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The integration resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:schedule", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "executions": { + "methods": { + "list": { + "description": "Lists the status of the integration executions.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.executions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: \"parameter_value\" HAS \\\"parameter1\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND event_execution_state=\\\"FAILED\\\"", + "location": "query", + "type": "string" + }, + "filterParams.customFilter": { + "description": "Optional user-provided custom filter.", + "location": "query", + "type": "string" + }, + "filterParams.endTime": { + "description": "End timestamp.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filterParams.eventStatuses": { + "description": "List of possible event statuses.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filterParams.executionId": { + "description": "Execution id.", + "location": "query", + "type": "string" + }, + "filterParams.parameterKey": { + "description": "Param key. DEPRECATED. User parameter_pair_key instead.", + "location": "query", + "type": "string" + }, + "filterParams.parameterPairKey": { + "description": "Param key in the key value pair filter.", + "location": "query", + "type": "string" + }, + "filterParams.parameterPairValue": { + "description": "Param value in the key value pair filter.", + "location": "query", + "type": "string" + }, + "filterParams.parameterType": { + "description": "Param type.", + "location": "query", + "type": "string" + }, + "filterParams.parameterValue": { + "description": "Param value. DEPRECATED. User parameter_pair_value instead.", + "location": "query", + "type": "string" + }, + "filterParams.startTime": { + "description": "Start timestamp.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filterParams.taskStatuses": { + "description": "List of possible task statuses.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filterParams.triggerId": { + "description": "Trigger id.", + "location": "query", + "type": "string" + }, + "filterParams.workflowName": { + "description": "Workflow name.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The results would be returned in order you specified here. Currently supporting \"last_modified_time\" and \"create_time\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The size of entries in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name of the integration execution.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "refreshAcl": { + "description": "Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.", + "location": "query", + "type": "boolean" + }, + "truncateParams": { + "description": "Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+parent}/executions", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListExecutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "versions": { + "methods": { + "archive": { + "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:archive", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.archive", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to archive. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:archive", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Create a integration with a draft version in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "newIntegration": { + "description": "Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/versions", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deactivate": { + "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.deactivate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to deactivate. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:deactivate", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a integration in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to retrieve. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of all integration versions in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "fieldMask": { + "description": "The field mask which specifies the particular data to be returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \">\" (greater), \"<\" (less than), >=\" (greater than or equal to), \"<=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\", \"snapshot_number\" Ascending sort order for \"name\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\". 3. projects//locations/-/integrations/- Meaning: \"List versions (with filter) for a client\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/versions", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a integration with a draft version in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.integrations.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Auto-generated primary key.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above integration that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "publish": { + "description": "This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.publish", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to publish. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:publish", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "takeoverEditLock": { + "description": "Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.takeoverEditLock", + "parameterOrder": [ + "integrationVersion" + ], + "parameters": { + "integrationVersion": { + "description": "Required. The version to take over edit lock. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+integrationVersion}:takeoverEditLock", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "validate": { + "description": "Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:validate", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.validate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to validate. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:validate", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "products": { + "methods": { + "createBundle": { + "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:createBundle", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.createBundle", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location resource of the request.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:createBundle", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaCreateBundleRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCreateBundleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listTaskEntities": { + "description": "This is a UI only method and will be moved away. Returns a list of common tasks.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:listTaskEntities", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.listTaskEntities", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location resource of the request. This is not going to be used but preserve the field for future.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:listTaskEntities", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "authConfigs": { + "methods": { + "create": { + "description": "Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.authConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "clientCertificate.encryptedPrivateKey": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "clientCertificate.passphrase": { + "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", + "location": "query", + "type": "string" + }, + "clientCertificate.sslCertificate": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. \"projects/{project}/locations/{location}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/authConfigs", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.products.authConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the AuthConfig.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.authConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the AuthConfig.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.authConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The size of entries in the response. If unspecified, defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The client, which owns this collection of AuthConfigs.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "The mask which specifies fields that need to be returned in the AuthConfig's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/authConfigs", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.products.authConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "clientCertificate.encryptedPrivateKey": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "clientCertificate.passphrase": { + "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", + "location": "query", + "type": "string" + }, + "clientCertificate.sslCertificate": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "location": "query", + "type": "string" + }, + "name": { + "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "certificates": { + "methods": { + "create": { + "description": "Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.certificates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. \"projects/{project}/locations/{location}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/certificates", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaCertificate" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCertificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a certificate", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.products.certificates.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the Certificate.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a certificates in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.certificates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCertificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List all the certificates that match the filter. Restrict to certificate of current client only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.certificates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The size of entries in the response. If unspecified, defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The client, which owns this collection of Certificates.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "The mask which specifies fields that need to be returned in the Certificate's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/certificates", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListCertificatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.products.certificates.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Auto generated primary key", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above Certificate that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaCertificate" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCertificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "integrations": { + "methods": { + "archiveBundle": { + "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:archiveBundle", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.archiveBundle", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The bundle to archive. Format: projects/{project}/integrations/{integration}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:archiveBundle", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaArchiveBundleRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaArchiveBundleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "execute": { + "description": "Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.execute", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The integration resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:execute", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of all integrations in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \">\" (greater), \"<\" (less than), >=\" (greater than or equal to), \"<=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "The results would be returned in order you specified here. Supported sort keys are: Descending sort order by \"last_modified_time\", \"created_time\", \"snapshot_number\". Ascending sort order by the integration name.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The page size for the resquest.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token for the resquest.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Project and location from which the integrations should be listed. Format: projects/{project}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/integrations", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "monitorexecutionstats": { + "description": "Get execution stats", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:monitorexecutionstats", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.monitorexecutionstats", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name: {parent=projects/*/locations/*}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:monitorexecutionstats", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "schedule": { + "description": "Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.schedule", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The integration resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:schedule", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "executions": { + "methods": { + "cancel": { + "description": "Cancellation of an execution", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.executions.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:cancel", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get an execution in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.executions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaExecution" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the status of the integration executions.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.executions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: \"parameter_value\" HAS \\\"parameter1\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND event_execution_state=\\\"FAILED\\\"", + "location": "query", + "type": "string" + }, + "filterParams.customFilter": { + "description": "Optional user-provided custom filter.", + "location": "query", + "type": "string" + }, + "filterParams.endTime": { + "description": "End timestamp.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filterParams.eventStatuses": { + "description": "List of possible event statuses.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filterParams.executionId": { + "description": "Execution id.", + "location": "query", + "type": "string" + }, + "filterParams.parameterKey": { + "description": "Param key. DEPRECATED. User parameter_pair_key instead.", + "location": "query", + "type": "string" + }, + "filterParams.parameterPairKey": { + "description": "Param key in the key value pair filter.", + "location": "query", + "type": "string" + }, + "filterParams.parameterPairValue": { + "description": "Param value in the key value pair filter.", + "location": "query", + "type": "string" + }, + "filterParams.parameterType": { + "description": "Param type.", + "location": "query", + "type": "string" + }, + "filterParams.parameterValue": { + "description": "Param value. DEPRECATED. User parameter_pair_value instead.", + "location": "query", + "type": "string" + }, + "filterParams.startTime": { + "description": "Start timestamp.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filterParams.taskStatuses": { + "description": "List of possible task statuses.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filterParams.triggerId": { + "description": "Trigger id.", + "location": "query", + "type": "string" + }, + "filterParams.workflowName": { + "description": "Workflow name.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The results would be returned in order you specified here. Currently supporting \"last_modified_time\" and \"create_time\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The size of entries in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name of the integration execution.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "refreshAcl": { + "description": "Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.", + "location": "query", + "type": "boolean" + }, + "truncateParams": { + "description": "Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+parent}/executions", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListExecutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "suspensions": { + "methods": { + "lift": { + "description": "* Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.executions.suspensions.lift", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource that the suspension belongs to. \"projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:lift", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaLiftSuspensionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaLiftSuspensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.executions.suspensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Standard filter field.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field name to order by.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of entries in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token to retrieve a specific page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/suspensions", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListSuspensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resolve": { + "description": "* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.executions.suspensions.resolve", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:resolve", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaResolveSuspensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "executionsnapshots": { + "methods": { + "list": { + "description": "Lists the snapshots of a given integration executions. This RPC is not being used.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executionsnapshots", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.executionsnapshots.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Currently supports filter by `execution_info_id` or `execution_snapshot_id`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Number of entries to be returned in a page.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token used to retrieve the next page results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name of the integration execution.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/executionsnapshots", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "versions": { + "methods": { + "archive": { + "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:archive", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.versions.archive", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to archive. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:archive", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Create a integration with a draft version in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "newIntegration": { + "description": "Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/versions", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deactivate": { + "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.versions.deactivate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to deactivate. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:deactivate", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "download": { + "description": "Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.versions.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "fileFormat": { + "description": "File format for download request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The version to download. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:download", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a integration in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to retrieve. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getBundle": { + "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:getBundle", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.versions.getBundle", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The bundle name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:getBundle", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaGetBundleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of all integration versions in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "fieldMask": { + "description": "The field mask which specifies the particular data to be returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \">\" (greater), \"<\" (less than), >=\" (greater than or equal to), \"<=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\", \"snapshot_number\" Ascending sort order for \"name\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\". 3. projects//locations/-/integrations/- Meaning: \"List versions (with filter) for a client\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/versions", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a integration with a draft version in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.products.integrations.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Auto-generated primary key.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above integration that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "publish": { + "description": "This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.versions.publish", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to publish. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:publish", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "takeoverEditLock": { + "description": "Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.versions.takeoverEditLock", + "parameterOrder": [ + "integrationVersion" + ], + "parameters": { + "integrationVersion": { + "description": "Required. The version to take over edit lock. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+integrationVersion}:takeoverEditLock", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateBundle": { + "description": "THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:updateBundle", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.products.integrations.versions.updateBundle", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Bundle name", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:updateBundle", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaUpdateBundleRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaUpdateBundleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upload": { + "description": "Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.versions.upload", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The version to upload. Format: projects/{project}/integrations/{integration}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/versions:upload", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "validate": { + "description": "Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:validate", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrations.versions.validate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The version to validate. Format: projects/{project}/integrations/{integration}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:validate", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "integrationtemplates": { + "resources": { + "versions": { + "methods": { + "create": { + "description": "Creates an IntegrationTemplateVersion.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.integrationtemplates.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this TemplateVersion will be created. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/versions", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns an IntegrationTemplateVersion in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrationtemplates.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The TemplateVersion to retrieve. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of all IntegrationTemplateVersions in the specified project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrationtemplates.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter syntax: defined in the EBNF grammar.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of IntegrationTemplateVersions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListIntegrationTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationTemplateVersions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/versions", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationTemplateVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sfdcInstances": { + "methods": { + "create": { + "description": "Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.sfdcInstances.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. \"projects/{project}/locations/{location}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcInstances", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an sfdc instance.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.products.sfdcInstances.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcInstance.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.sfdcInstances.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcInstance.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.sfdcInstances.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The size of entries in the response. If unspecified, defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The client, which owns this collection of SfdcInstances.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "The mask which specifies fields that need to be returned in the SfdcInstance's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcInstances", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.products.sfdcInstances.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "sfdcChannels": { + "methods": { + "create": { + "description": "Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels", + "httpMethod": "POST", + "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. \"projects/{project}/locations/{location}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcChannels", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an sfdc channel.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcChannel.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcChannel.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The size of entries in the response. If unspecified, defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The client, which owns this collection of SfdcChannels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "The mask which specifies fields that need to be returned in the SfdcChannel's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcChannels", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "sfdcInstances": { + "methods": { + "create": { + "description": "Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances", + "httpMethod": "POST", + "id": "integrations.projects.locations.sfdcInstances.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. \"projects/{project}/locations/{location}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcInstances", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an sfdc instance.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.sfdcInstances.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcInstance.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.sfdcInstances.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcInstance.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances", + "httpMethod": "GET", + "id": "integrations.projects.locations.sfdcInstances.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The size of entries in the response. If unspecified, defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The client, which owns this collection of SfdcInstances.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "The mask which specifies fields that need to be returned in the SfdcInstance's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcInstances", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.sfdcInstances.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "sfdcChannels": { + "methods": { + "create": { + "description": "Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels", + "httpMethod": "POST", + "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. \"projects/{project}/locations/{location}\" format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcChannels", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an sfdc channel.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcChannel.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name that is associated with the SfdcChannel.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels", + "httpMethod": "GET", + "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The size of entries in the response. If unspecified, defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The client, which owns this collection of SfdcChannels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "The mask which specifies fields that need to be returned in the SfdcChannel's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sfdcChannels", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20220913", + "rootUrl": "https://integrations.googleapis.com/", + "schemas": { + "CrmlogErrorCode": { + "description": "Registered ids for errors, as \"oneof\" enums. Each task or logical grouping of tasks may share the same enum.", + "id": "CrmlogErrorCode", + "properties": { + "commonErrorCode": { + "enum": [ + "COMMON_ERROR_CODE_UNSPECIFIED", + "INVALID_CREDENTIALS", + "REQUIRED_FIELDS_MISSING", + "INVALID_FIELDS", + "BACKEND", + "GENERAL", + "INTERNAL", + "IO_ERROR", + "NOT_FOUND", + "EVENT_BUS", + "ALREADY_EXISTS", + "CONCORD", + "CONVERSION", + "FLUME", + "PERMISSION", + "SALES_FORCE", + "SPANNER", + "UNIMPLEMENTED", + "RELTIO", + "WORKFLOW_NOT_FOUND", + "QUOTA_THROTTLED", + "QUOTA_ENQUEUED", + "INVALID_QUOTA_CONFIGURATION", + "TASK_NOT_FOUND", + "EXECUTION_TIMEOUT", + "INVALID_EVENT_EXECUTION_STATE", + "INVALID_ATTRIBUTE", + "MISSING_ATTRIBUTE", + "CLIENT_UNAUTHORIZED_FOR_WORKFLOW", + "INVALID_PARAMETER", + "MISSING_PARAMETER", + "UNAUTHROIZED_WORKFLOW_EDITOR_ACTION", + "FAILED_PRECONDITION", + "INVALID_CLIENT", + "MISSING_CLIENT", + "INVALID_WORKFLOW", + "MISSING_QUOTA_CONFIGURATION", + "UNHANDLED_TASK_ERROR", + "SCRIPT_TASK_RUNTIME_ERROR", + "RPC", + "INVALID_PROTO", + "UNHANDLED_EVENTBUS_ERROR", + "INVALID_TASK_STATE", + "TYPED_TASK_INVALID_INPUT_OPERATION", + "TYPED_TASK_INVALID_OUTPUT_OPERATION", + "VALIDATION_ERROR", + "RESUME_ERROR", + "APPS_SCRIPT_EXECUTION_ERROR", + "INVALID_VECTOR_USER", + "INFORMATICA", + "RETRYABLE_TASK_ERROR", + "INVALID_TENANT", + "WRONG_TENANT", + "INFORMATICA_BACKEND_UNAVAILABLE", + "RPC_PERMISSION_DENIED", + "SYNC_EVENTBUS_EXECUTION_TIMEOUT", + "ASYNC_EVENTBUS_EXECUTION_TIMEOUT", + "NOT_SUPPORTED_DATA_TYPE", + "UNSANITIZED_USER_INPUT", + "TRANSFORM_EXPRESSION_EVALUATION_ERROR", + "HTTP_EXCEPTION", + "EXECUTION_CANCELLED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only.", + "ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. This error will be counted as server availability error.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmCardsCellValue": { + "id": "EnterpriseCrmCardsCellValue", + "properties": { + "booleanValue": { + "type": "boolean" + }, + "doubleValue": { + "format": "double", + "type": "number" + }, + "empty": { + "$ref": "GoogleProtobufEmpty" + }, + "longValue": { + "format": "int64", + "type": "string" + }, + "stringValue": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmCardsRow": { + "id": "EnterpriseCrmCardsRow", + "properties": { + "cells": { + "description": "Ordered list of cell values within a row.", + "items": { + "$ref": "EnterpriseCrmCardsCellValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmCardsTabularData": { + "description": "The generic data format returned from all connectors.", + "id": "EnterpriseCrmCardsTabularData", + "properties": { + "headers": { + "description": "Ordered list of column headers.", + "items": { + "type": "string" + }, + "type": "array" + }, + "rows": { + "description": "Ordered list of table rows.", + "items": { + "$ref": "EnterpriseCrmCardsRow" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmCardsTemplatesAplosSeriesData": { + "description": "Data used to render an Aplos Series card.", + "id": "EnterpriseCrmCardsTemplatesAplosSeriesData", + "properties": { + "rows": { + "description": "A single Series Row", + "items": { + "$ref": "EnterpriseCrmCardsTemplatesAplosSeriesDataRow" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmCardsTemplatesAplosSeriesDataRow": { + "description": "Aplos series row is exactly two columns labeled x and y.", + "id": "EnterpriseCrmCardsTemplatesAplosSeriesDataRow", + "properties": { + "x": { + "$ref": "EnterpriseCrmCardsCellValue" + }, + "y": { + "$ref": "EnterpriseCrmCardsCellValue" + } + }, + "type": "object" + }, + "EnterpriseCrmCardsTemplatesAplosSeriesListData": { + "description": "Data used for Aplos charts that accept multiple Series.", + "id": "EnterpriseCrmCardsTemplatesAplosSeriesListData", + "properties": { + "series": { + "items": { + "$ref": "EnterpriseCrmCardsTemplatesAplosSeriesListDataSeries" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmCardsTemplatesAplosSeriesListDataSeries": { + "id": "EnterpriseCrmCardsTemplatesAplosSeriesListDataSeries", + "properties": { + "data": { + "$ref": "EnterpriseCrmCardsTemplatesAplosSeriesData" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam": { + "id": "EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam", + "properties": { + "allowedCredentialTypes": { + "description": "Defines the credential types to be supported as Task may restrict specific types to use, e.g. Cloud SQL Task will use username/password type only.", + "items": { + "enum": [ + "CREDENTIAL_TYPE_UNSPECIFIED", + "USERNAME_AND_PASSWORD", + "API_KEY", + "OAUTH2_AUTHORIZATION_CODE", + "OAUTH2_IMPLICIT", + "OAUTH2_CLIENT_CREDENTIALS", + "OAUTH2_RESOURCE_OWNER_CREDENTIALS", + "JWT", + "AUTH_TOKEN", + "SERVICE_ACCOUNT", + "CLIENT_CERTIFICATE_ONLY", + "OIDC_TOKEN" + ], + "enumDescriptions": [ + "", + "Regular username/password pair.", + "API key.", + "OAuth 2.0 Authorization Code Grant Type.", + "OAuth 2.0 Implicit Grant Type.", + "OAuth 2.0 Client Credentials Grant Type.", + "OAuth 2.0 Resource Owner Credentials Grant Type.", + "JWT Token.", + "Auth Token, e.g. bearer token.", + "Service Account which can be used to generate token for authentication.", + "Client Certificate only.", + "Google OIDC ID Token" + ], + "type": "string" + }, + "type": "array" + }, + "allowedServiceAccountInContext": { + "type": "boolean" + }, + "authConfigId": { + "description": "UUID of the AuthConfig.", + "type": "string" + }, + "scope": { + "description": "A space-delimited list of requested scope permissions.", + "type": "string" + }, + "useServiceAccountInContext": { + "type": "boolean" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoAddress": { + "description": "Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.", + "id": "EnterpriseCrmEventbusProtoAddress", + "properties": { + "email": { + "description": "Required.", + "type": "string" + }, + "name": { + "type": "string" + }, + "tokens": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoToken" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoAttributes": { + "description": "Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8", + "id": "EnterpriseCrmEventbusProtoAttributes", + "properties": { + "dataType": { + "description": "Things like URL, Email, Currency, Timestamp (rather than string, int64...)", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "EMAIL", + "URL", + "CURRENCY", + "TIMESTAMP", + "DOMAIN_NAME" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "Domain is a web url string with one top-level private domain and a suffix (for example: google.com, walmart.com)" + ], + "type": "string" + }, + "defaultValue": { + "$ref": "EnterpriseCrmEventbusProtoValueType", + "description": "Used to define defaults." + }, + "isRequired": { + "description": "Required for event execution. The validation will be done by the event bus when the event is triggered.", + "type": "boolean" + }, + "isSearchable": { + "description": "Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.", + "type": "boolean" + }, + "logSettings": { + "$ref": "EnterpriseCrmEventbusProtoLogSettings", + "description": "See go/integration-platform/analytics/logging_task.md for details." + }, + "searchable": { + "enum": [ + "UNSPECIFIED", + "YES", + "NO" + ], + "enumDescriptions": [ + "", + "If yes, the parameter key and value will be full-text indexed. In a proto, this value will propagate to all children whose searchable is unspecified.", + "If no, the parameter key and value will not be full-text indexed. In a proto, this value will propagate to all children whose searchable is unspecified." + ], + "type": "string" + }, + "taskVisibility": { + "description": "List of tasks that can view this property, if empty then all.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList": { + "description": "List of error enums for alerts.", + "id": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList", + "properties": { + "enumStrings": { + "items": { + "type": "string" + }, + "type": "array" + }, + "filterType": { + "enum": [ + "DEFAULT_INCLUSIVE", + "EXCLUSIVE" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue": { + "description": "The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples", + "id": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue", + "properties": { + "absolute": { + "format": "int64", + "type": "string" + }, + "percentage": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBaseFunction": { + "id": "EnterpriseCrmEventbusProtoBaseFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "NOW_IN_MILLIS", + "INT_LIST", + "ENVIRONMENT", + "GET_EXECUTION_ID", + "GET_INTEGRATION_NAME", + "GET_REGION", + "GET_UUID", + "GET_PROJECT_ID" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBaseValue": { + "id": "EnterpriseCrmEventbusProtoBaseValue", + "properties": { + "baseFunction": { + "$ref": "EnterpriseCrmEventbusProtoFunction", + "description": "Start with a function that does not build on existing values. Eg. CurrentTime, Min, Max, Exists, etc." + }, + "literalValue": { + "$ref": "EnterpriseCrmEventbusProtoParameterValueType", + "description": "Start with a literal value." + }, + "referenceValue": { + "description": "Start with a reference value to dereference.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBooleanArrayFunction": { + "id": "EnterpriseCrmEventbusProtoBooleanArrayFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "GET", + "APPEND", + "SIZE", + "TO_SET", + "APPEND_ALL", + "TO_JSON", + "SET", + "REMOVE", + "REMOVE_AT", + "CONTAINS", + "FOR_EACH", + "FILTER" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBooleanFunction": { + "id": "EnterpriseCrmEventbusProtoBooleanFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "TO_JSON", + "NOT", + "AND", + "NAND", + "OR", + "XOR", + "NOR", + "XNOR", + "TO_STRING", + "EQUALS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBooleanParameterArray": { + "id": "EnterpriseCrmEventbusProtoBooleanParameterArray", + "properties": { + "booleanValues": { + "items": { + "type": "boolean" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoBuganizerNotification": { + "id": "EnterpriseCrmEventbusProtoBuganizerNotification", + "properties": { + "assigneeEmailAddress": { + "description": "Whom to assign the new bug. Optional.", + "type": "string" + }, + "componentId": { + "description": "ID of the buganizer component within which to create a new issue. Required.", + "format": "int64", + "type": "string" + }, + "templateId": { + "description": "ID of the buganizer template to use. Optional.", + "format": "int64", + "type": "string" + }, + "title": { + "description": "Title of the issue to be created. Required.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoCombinedCondition": { + "description": "This message recursively combines constituent conditions using logical AND.", + "id": "EnterpriseCrmEventbusProtoCombinedCondition", + "properties": { + "conditions": { + "description": "A set of individual constituent conditions.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoCondition" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoCondition": { + "description": "Condition that uses `operator` to evaluate the key against the value.", + "id": "EnterpriseCrmEventbusProtoCondition", + "properties": { + "eventPropertyKey": { + "description": "Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.", + "type": "string" + }, + "operator": { + "description": "Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.", + "enum": [ + "UNSET", + "EQUALS", + "CONTAINS", + "LESS_THAN", + "GREATER_THAN", + "EXISTS", + "DOES_NOT_EXIST", + "IS_EMPTY", + "IS_NOT_EMPTY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "value": { + "$ref": "EnterpriseCrmEventbusProtoValueType", + "description": "Value that's checked for the key." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoConditionResult": { + "description": "Contains the combined condition calculation results.", + "id": "EnterpriseCrmEventbusProtoConditionResult", + "properties": { + "currentTaskNumber": { + "description": "the current task number.", + "type": "string" + }, + "nextTaskNumber": { + "description": "the next task number.", + "type": "string" + }, + "result": { + "description": "the result comes out after evaluate the combined condition. True if there's no combined condition specified.", + "type": "boolean" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoConnectorsConnection": { + "id": "EnterpriseCrmEventbusProtoConnectorsConnection", + "properties": { + "connectionName": { + "description": "Connection name Format: projects/{project}/locations/{location}/connections/{connection}", + "type": "string" + }, + "connectorVersion": { + "description": "Connector version Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}", + "type": "string" + }, + "serviceName": { + "description": "Service name Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig": { + "id": "EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig", + "properties": { + "connection": { + "$ref": "EnterpriseCrmEventbusProtoConnectorsConnection", + "description": "User-selected connection." + }, + "operation": { + "description": "Operation to perform using the configured connection.", + "enum": [ + "OPERATION_UNSPECIFIED", + "EXECUTE_ACTION", + "LIST_ENTITIES", + "GET_ENTITY", + "CREATE_ENTITY", + "UPDATE_ENTITY", + "DELETE_ENTITY" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoCoordinate": { + "description": "Represents two-dimensional positions.", + "id": "EnterpriseCrmEventbusProtoCoordinate", + "properties": { + "x": { + "format": "int32", + "type": "integer" + }, + "y": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoCustomSuspensionRequest": { + "id": "EnterpriseCrmEventbusProtoCustomSuspensionRequest", + "properties": { + "postToQueueWithTriggerIdRequest": { + "$ref": "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest", + "description": "Request to fire an event containing the SuspensionInfo message." + }, + "suspensionInfoEventParameterKey": { + "description": "In the fired event, set the SuspensionInfo message as the value for this key.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoDoubleArray": { + "id": "EnterpriseCrmEventbusProtoDoubleArray", + "properties": { + "values": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoDoubleArrayFunction": { + "id": "EnterpriseCrmEventbusProtoDoubleArrayFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "GET", + "APPEND", + "SIZE", + "SUM", + "AVG", + "MAX", + "MIN", + "TO_SET", + "APPEND_ALL", + "TO_JSON", + "SET", + "REMOVE", + "REMOVE_AT", + "CONTAINS", + "FOR_EACH", + "FILTER" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoDoubleFunction": { + "id": "EnterpriseCrmEventbusProtoDoubleFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "TO_JSON", + "TO_STRING", + "ADD", + "SUBTRACT", + "MULTIPLY", + "DIVIDE", + "EXPONENT", + "ROUND", + "FLOOR", + "CEIL", + "GREATER_THAN", + "LESS_THAN", + "EQUALS", + "GREATER_THAN_EQUALS", + "LESS_THAN_EQUALS", + "MOD" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoDoubleParameterArray": { + "id": "EnterpriseCrmEventbusProtoDoubleParameterArray", + "properties": { + "doubleValues": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoErrorDetail": { + "description": "An error, warning, or information message associated with a workflow.", + "id": "EnterpriseCrmEventbusProtoErrorDetail", + "properties": { + "errorCode": { + "$ref": "CrmlogErrorCode", + "description": "The associated error-code, which can be a common or internal code." + }, + "errorMessage": { + "description": "The full text of the error message, including any parameters that were thrown along with the exception.", + "type": "string" + }, + "severity": { + "description": "The severity of the error: ERROR|WARN|INFO.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "ERROR", + "WARN", + "INFO" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "taskNumber": { + "description": "The task try-number, in which, the error occurred. If zero, the error happened at the event level.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoEventBusProperties": { + "description": "LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.", + "id": "EnterpriseCrmEventbusProtoEventBusProperties", + "properties": { + "properties": { + "description": "An unordered list of property entries.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoPropertyEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoEventExecutionDetails": { + "description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10", + "id": "EnterpriseCrmEventbusProtoEventExecutionDetails", + "properties": { + "eventAttemptStats": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats" + }, + "type": "array" + }, + "eventExecutionSnapshot": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshot" + }, + "type": "array" + }, + "eventExecutionState": { + "enum": [ + "UNSPECIFIED", + "ON_HOLD", + "IN_PROCESS", + "SUCCEEDED", + "FAILED", + "CANCELED", + "RETRY_ON_HOLD", + "SUSPENDED" + ], + "enumDescriptions": [ + "", + "Event is received and waiting for the execution. This happens when firing the event via \"postToQueue\" or \"schedule\".", + "Event is under processing.", + "Event execution successfully finished. There's no more change after this state.", + "Event execution failed. There's no more change after this state.", + "Event execution canceled by user. There's no more change after this state.", + "Event execution failed and waiting for retry.", + "Event execution suspended and waiting for manual intervention." + ], + "type": "string" + }, + "eventRetriesFromBeginningCount": { + "description": "Indicates the number of times the execution has restarted from the beginning.", + "format": "int32", + "type": "integer" + }, + "logFilePath": { + "description": "The log file path (aka. cns address) for this event.", + "type": "string" + }, + "networkAddress": { + "description": "The network address (aka. bns address) that indicates where the event executor is running.", + "type": "string" + }, + "nextExecutionTime": { + "description": "Next scheduled execution time in case the execution status was RETRY_ON_HOLD.", + "format": "int64", + "type": "string" + }, + "ryeLockUnheldCount": { + "description": "Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats": { + "id": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats", + "properties": { + "endTime": { + "description": "The end time of the event execution for current attempt.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "The start time of the event execution for current attempt. This could be in the future if it's been scheduled.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoEventExecutionSnapshot": { + "description": "Contains the snapshot of the event execution for a given checkpoint. Next available id: 13", + "id": "EnterpriseCrmEventbusProtoEventExecutionSnapshot", + "properties": { + "checkpointTaskNumber": { + "description": "Indicates \"right after which checkpoint task's execution\" this snapshot is taken.", + "type": "string" + }, + "conditionResults": { + "description": "All of the computed conditions that been calculated.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoConditionResult" + }, + "type": "array" + }, + "diffParams": { + "$ref": "EnterpriseCrmEventbusProtoEventParameters", + "description": "The parameters in Event object that differs from last snapshot." + }, + "eventExecutionInfoId": { + "description": "Points to the event execution info this snapshot belongs to.", + "type": "string" + }, + "eventExecutionSnapshotId": { + "description": "Auto-generated. Used as primary key for EventExecutionSnapshots table.", + "type": "string" + }, + "eventExecutionSnapshotMetadata": { + "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata" + }, + "eventParams": { + "$ref": "EnterpriseCrmEventbusProtoEventParameters", + "description": "The parameters in Event object." + }, + "exceedMaxSize": { + "description": "indicate whether snapshot exceeded maximum size before clean up", + "type": "boolean" + }, + "snapshotTime": { + "description": "Indicates when this snapshot is taken.", + "format": "int64", + "type": "string" + }, + "taskExecutionDetails": { + "description": "All of the task execution details at the given point of time.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoTaskExecutionDetails" + }, + "type": "array" + }, + "taskName": { + "description": "The task name associated with this snapshot. Could be empty.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata": { + "id": "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata", + "properties": { + "eventAttemptNum": { + "description": "the event attempt number this snapshot belongs to.", + "format": "int32", + "type": "integer" + }, + "taskAttemptNum": { + "description": "the task attempt number this snapshot belongs to. Could be empty.", + "format": "int32", + "type": "integer" + }, + "taskName": { + "description": "the task name associated with this snapshot. Could be empty.", + "type": "string" + }, + "taskNumber": { + "description": "The task number associated with this snapshot. Could be empty.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoEventParameters": { + "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4", + "id": "EnterpriseCrmEventbusProtoEventParameters", + "properties": { + "parameters": { + "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoParameterEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoExecutionTraceInfo": { + "description": "Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships.", + "id": "EnterpriseCrmEventbusProtoExecutionTraceInfo", + "properties": { + "parentEventExecutionInfoId": { + "description": "Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.", + "type": "string" + }, + "traceId": { + "description": "Used to aggregate ExecutionTraceInfo.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoExternalTraffic": { + "description": "Represents external traffic type and id.", + "id": "EnterpriseCrmEventbusProtoExternalTraffic", + "properties": { + "gcpProjectId": { + "description": "User\u2019s GCP project id the traffic is referring to.", + "type": "string" + }, + "gcpProjectNumber": { + "description": "User\u2019s GCP project number the traffic is referring to.", + "type": "string" + }, + "location": { + "description": "Location for the user's request.", + "type": "string" + }, + "source": { + "description": "LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product)", + "enum": [ + "SOURCE_UNSPECIFIED", + "APIGEE", + "SECURITY" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoFailurePolicy": { + "description": "Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).", + "id": "EnterpriseCrmEventbusProtoFailurePolicy", + "properties": { + "intervalInSeconds": { + "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.", + "format": "int64", + "type": "string" + }, + "maxNumRetries": { + "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.", + "format": "int32", + "type": "integer" + }, + "retryStrategy": { + "description": "Defines what happens to the task upon failure.", + "enum": [ + "UNSPECIFIED", + "IGNORE", + "NONE", + "FATAL", + "FIXED_INTERVAL", + "LINEAR_BACKOFF", + "EXPONENTIAL_BACKOFF", + "RESTART_WORKFLOW_WITH_BACKOFF" + ], + "enumDescriptions": [ + "", + "Ignores the failure of this task. The rest of the workflow will be executed Assuming this task succeeded.", + "Causes a permanent failure of the task. However, if the last task(s) of event was successfully completed despite the failure of this task, it has no impact on the workflow.", + "Causes a permanent failure of the event. It is different from NONE because this will mark the event as FAILED by shutting down the event execution.", + "The task will be retried from the failed task onwards after a fixed delay. A max-retry count is required to be specified with this strategy. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. Max_num_retries and interval_in_seconds must be specified.", + "The task will be retried from the failed task onwards after a fixed delay that linearly increases with each retry attempt. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. Max_num_retries and interval_in_seconds must be specified.", + "The task will be retried after an exponentially increasing period of time with each failure. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. `max_num_retries` and `interval_in_seconds` must be specified.", + "The entire workflow will be restarted with the initial parameters that were set when the event was fired. A max-retry count is required to be specified with this strategy. `max_num_retries` and `interval_in_seconds` must be specified." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoField": { + "description": "Information about the value and type of the field. Next Id: 8", + "id": "EnterpriseCrmEventbusProtoField", + "properties": { + "cardinality": { + "description": "By default, if the cardinality is unspecified the field is considered required while mapping.", + "enum": [ + "UNSPECIFIED", + "OPTIONAL" + ], + "enumDescriptions": [ + "For fields with unspecified cardinality.", + "If field cardinality is set to optional, ignore errors if input field value is null or the reference_key is not found." + ], + "type": "string" + }, + "defaultValue": { + "$ref": "EnterpriseCrmEventbusProtoParameterValueType", + "description": "This holds the default values for the fields. This value is supplied by user so may or may not contain PII or SPII data. This field will be scrubbed using DatapolScrubber#maybeScrub() with go/proto-sanitizer#level3" + }, + "fieldType": { + "description": "Specifies the data type of the field.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + }, + "protoDefPath": { + "description": "Optional. The fully qualified proto name (e.g. enterprise.crm.storage.Account). Required for output field of type PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES and output field_type is PROTO_VALUE, then fully qualified proto type url should be provided to parse the input bytes. If field_type is *_ARRAY, then all the converted protos are of the same type.", + "type": "string" + }, + "referenceKey": { + "description": "This holds the reference key of the workflow or task parameter. 1. Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input or output parameter, for e.g. $task1_param1$. 3. Any workflow or task parameters with subfield references, for e.g., $task1_param1.employee.id$", + "type": "string" + }, + "transformExpression": { + "$ref": "EnterpriseCrmEventbusProtoTransformExpression", + "description": "This is the transform expression to fetch the input field value. for e.g. $param1$.CONCAT('test'). See go/transform-functions-design for more details. Keep points - 1. Only input field can have a transform expression. 2. If a transform expression is provided, reference_key will be ignored. 3. If no value is returned after evaluation of transform expression, default_value can be mapped if provided. 4. The field_type should be the type of the final object returned after the transform expression is evaluated. Scrubs the transform expression before logging as value provided by user so may or may not contain PII or SPII data." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoFieldMappingConfig": { + "description": "Field Mapping Config to map multiple output fields values from input fields values. Next id: 2", + "id": "EnterpriseCrmEventbusProtoFieldMappingConfig", + "properties": { + "mappedFields": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoMappedField" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoFunction": { + "id": "EnterpriseCrmEventbusProtoFunction", + "properties": { + "functionType": { + "$ref": "EnterpriseCrmEventbusProtoFunctionType", + "description": "The name of the function to perform." + }, + "parameters": { + "description": "List of parameters required for the transformation.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoTransformExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoFunctionType": { + "id": "EnterpriseCrmEventbusProtoFunctionType", + "properties": { + "baseFunction": { + "$ref": "EnterpriseCrmEventbusProtoBaseFunction", + "description": "LINT.IfChange" + }, + "booleanArrayFunction": { + "$ref": "EnterpriseCrmEventbusProtoBooleanArrayFunction" + }, + "booleanFunction": { + "$ref": "EnterpriseCrmEventbusProtoBooleanFunction" + }, + "doubleArrayFunction": { + "$ref": "EnterpriseCrmEventbusProtoDoubleArrayFunction" + }, + "doubleFunction": { + "$ref": "EnterpriseCrmEventbusProtoDoubleFunction" + }, + "intArrayFunction": { + "$ref": "EnterpriseCrmEventbusProtoIntArrayFunction" + }, + "intFunction": { + "$ref": "EnterpriseCrmEventbusProtoIntFunction" + }, + "jsonFunction": { + "$ref": "EnterpriseCrmEventbusProtoJsonFunction", + "description": "LINT.ThenChange(//depot/google3/alkali/apps/integrationplatform/client/workflow_editor/utils/transform_function.ts)" + }, + "protoArrayFunction": { + "$ref": "EnterpriseCrmEventbusProtoProtoArrayFunction" + }, + "protoFunction": { + "$ref": "EnterpriseCrmEventbusProtoProtoFunction" + }, + "stringArrayFunction": { + "$ref": "EnterpriseCrmEventbusProtoStringArrayFunction" + }, + "stringFunction": { + "$ref": "EnterpriseCrmEventbusProtoStringFunction" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoIntArray": { + "id": "EnterpriseCrmEventbusProtoIntArray", + "properties": { + "values": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoIntArrayFunction": { + "id": "EnterpriseCrmEventbusProtoIntArrayFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "GET", + "APPEND", + "SIZE", + "SUM", + "AVG", + "MAX", + "MIN", + "TO_SET", + "APPEND_ALL", + "TO_JSON", + "SET", + "REMOVE", + "REMOVE_AT", + "CONTAINS", + "FOR_EACH", + "FILTER" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoIntFunction": { + "id": "EnterpriseCrmEventbusProtoIntFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "ADD", + "SUBTRACT", + "MULTIPLY", + "DIVIDE", + "EXPONENT", + "GREATER_THAN_EQUAL_TO", + "GREATER_THAN", + "LESS_THAN_EQUAL_TO", + "LESS_THAN", + "TO_DOUBLE", + "TO_STRING", + "EQUALS", + "TO_JSON", + "MOD", + "EPOCH_TO_HUMAN_READABLE_TIME" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoIntParameterArray": { + "id": "EnterpriseCrmEventbusProtoIntParameterArray", + "properties": { + "intValues": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoJsonFunction": { + "id": "EnterpriseCrmEventbusProtoJsonFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "GET_PROPERTY", + "GET_ELEMENT", + "APPEND_ELEMENT", + "SIZE", + "SET_PROPERTY", + "FLATTEN", + "FLATTEN_ONCE", + "MERGE", + "TO_STRING", + "TO_INT", + "TO_DOUBLE", + "TO_BOOLEAN", + "TO_PROTO", + "TO_STRING_ARRAY", + "TO_INT_ARRAY", + "TO_DOUBLE_ARRAY", + "TO_PROTO_ARRAY", + "TO_BOOLEAN_ARRAY", + "REMOVE_PROPERTY", + "RESOLVE_TEMPLATE", + "EQUALS", + "FOR_EACH", + "FILTER_ELEMENTS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "next id: 24" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoLogSettings": { + "description": "The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details.", + "id": "EnterpriseCrmEventbusProtoLogSettings", + "properties": { + "logFieldName": { + "description": "The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.", + "type": "string" + }, + "sanitizeOptions": { + "$ref": "EnterpriseCrmLoggingGwsSanitizeOptions", + "description": "Contains the scrubbing options, such as whether to scrub, obfuscate, etc." + }, + "seedPeriod": { + "enum": [ + "SEED_PERIOD_UNSPECIFIED", + "DAY", + "WEEK", + "MONTH" + ], + "enumDescriptions": [ + "", + "Sanitized values remain constant for the day of the event.", + "Sanitized values remain constant for the week of the event; may cross month boundaries.", + "Sanitized values remain constant for the month of the event." + ], + "type": "string" + }, + "seedScope": { + "enum": [ + "SEED_SCOPE_UNSPECIFIED", + "EVENT_NAME", + "TIME_PERIOD", + "PARAM_NAME" + ], + "enumDescriptions": [ + "", + "Hash computations include the event name.", + "Hash computations include a time period.", + "Hash computations include the param name." + ], + "type": "string" + }, + "shorteningLimits": { + "$ref": "EnterpriseCrmLoggingGwsFieldLimits", + "description": "Contains the field limits for shortening, such as max string length and max array length." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoLoopMetadata": { + "id": "EnterpriseCrmEventbusProtoLoopMetadata", + "properties": { + "currentIterationCount": { + "description": "Starting from 1, not 0.", + "format": "int64", + "type": "string" + }, + "currentIterationDetail": { + "description": "Needs to be set by the loop impl class before each iteration. The abstract loop class will append the request and response to it. Eg. The foreach Loop will clean up and set it as the current iteration element at the start of each loop. The post request and response will be appended to the value once they are available.", + "type": "string" + }, + "errorMsg": { + "description": "Add the error message when loops fail.", + "type": "string" + }, + "failureLocation": { + "description": "Indicates where in the loop logic did it error out.", + "enum": [ + "UNKNOWN", + "SUBWORKFLOW", + "PARAM_OVERRIDING", + "PARAM_AGGREGATING", + "SETTING_ITERATION_ELEMENT", + "GETTING_LIST_TO_ITERATE", + "CONDITION_EVALUATION", + "BUILDING_REQUEST" + ], + "enumDescriptions": [ + "No error or Unknown.", + "Subworkflow failed while firing/running.", + "Param overrides failed.", + "Param aggregation failed.", + "Setting for loop current element failed.", + "Getting the list to iterate.", + "Evaluating the while loop condition.", + "Building the iteration request" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoMappedField": { + "description": "Mapped field is a pair of input field and output field. Next Id: 3", + "id": "EnterpriseCrmEventbusProtoMappedField", + "properties": { + "inputField": { + "$ref": "EnterpriseCrmEventbusProtoField", + "description": "The input field being mapped from." + }, + "outputField": { + "$ref": "EnterpriseCrmEventbusProtoField", + "description": "The output field being mapped to." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoNextTask": { + "description": "The task that is next in line to be executed, if the condition specified evaluated to true.", + "id": "EnterpriseCrmEventbusProtoNextTask", + "properties": { + "combinedConditions": { + "description": "Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`", + "items": { + "$ref": "EnterpriseCrmEventbusProtoCombinedCondition" + }, + "type": "array" + }, + "condition": { + "description": "Standard filter expression for this task to become an eligible next task.", + "type": "string" + }, + "description": { + "description": "User-provided description intended to give more business context about the next task edge or condition.", + "type": "string" + }, + "label": { + "description": "User-provided label that is attached to this edge in the UI.", + "type": "string" + }, + "taskConfigId": { + "description": "ID of the next task.", + "type": "string" + }, + "taskNumber": { + "description": "Task number of the next task.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoNextTeardownTask": { + "description": "The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).", + "id": "EnterpriseCrmEventbusProtoNextTeardownTask", + "properties": { + "name": { + "description": "Required. Name of the next teardown task.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoNodeIdentifier": { + "description": "Represents a node identifier (type + id). Next highest id: 3", + "id": "EnterpriseCrmEventbusProtoNodeIdentifier", + "properties": { + "elementIdentifier": { + "description": "Configuration of the edge.", + "type": "string" + }, + "elementType": { + "description": "Destination node where the edge ends. It can only be a task config.", + "enum": [ + "UNKNOWN_TYPE", + "TASK_CONFIG", + "TRIGGER_CONFIG" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoNotification": { + "id": "EnterpriseCrmEventbusProtoNotification", + "properties": { + "buganizerNotification": { + "$ref": "EnterpriseCrmEventbusProtoBuganizerNotification" + }, + "emailAddress": { + "$ref": "EnterpriseCrmEventbusProtoAddress" + }, + "escalatorQueue": { + "type": "string" + }, + "pubsubTopic": { + "type": "string" + }, + "request": { + "$ref": "EnterpriseCrmEventbusProtoCustomSuspensionRequest", + "description": "If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParamSpecEntryConfig": { + "id": "EnterpriseCrmEventbusProtoParamSpecEntryConfig", + "properties": { + "descriptivePhrase": { + "description": "A short phrase to describe what this parameter contains.", + "type": "string" + }, + "helpText": { + "description": "Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.", + "type": "string" + }, + "hideDefaultValue": { + "description": "Whether the default value is hidden in the UI.", + "type": "boolean" + }, + "inputDisplayOption": { + "enum": [ + "DEFAULT", + "STRING_MULTI_LINE", + "NUMBER_SLIDER", + "BOOLEAN_TOGGLE" + ], + "enumDescriptions": [ + "A single-line input for strings, a numeric input box for numbers, or a checkbox for booleans.", + "A multi-line input box for longer strings/string templates.", + "A slider to select a numerical value. The default range is [0, 100].", + "A toggle button for boolean parameters." + ], + "type": "string" + }, + "isHidden": { + "description": "Whether this field is hidden in the UI.", + "type": "boolean" + }, + "label": { + "description": "A user-friendly label for the parameter.", + "type": "string" + }, + "parameterNameOption": { + "enum": [ + "DEFAULT_NOT_PARAMETER_NAME", + "IS_PARAMETER_NAME", + "KEY_IS_PARAMETER_NAME", + "VALUE_IS_PARAMETER_NAME" + ], + "enumDescriptions": [ + "This field is not a parameter name.", + "If this field is a string and this option is selected, the field will be interpreted as a parameter name. Users will be able to choose a variable using the autocomplete, but the name will be stored as a literal string.", + "If this field is a ParameterMap and this option is selected, the map's keys will be interpreted as parameter names. Ignored if this field is not a ParameterMap.", + "If this field is a ParameterMap and this option is selected, the map's values will be interpreted as parameter names. Ignored if this field is not a ParameterMap." + ], + "type": "string" + }, + "subSectionLabel": { + "description": "A user-friendly label for subSection under which the parameter will be displayed.", + "type": "string" + }, + "uiPlaceholderText": { + "description": "Placeholder text which will appear in the UI input form for this parameter.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition": { + "id": "EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition", + "properties": { + "fullName": { + "description": "The fully-qualified proto name. This message, for example, would be \"enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition\".", + "type": "string" + }, + "path": { + "description": "Path to the proto file that contains the message type's definition.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParamSpecEntryValidationRule": { + "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRule", + "properties": { + "doubleRange": { + "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange" + }, + "intRange": { + "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange" + }, + "stringRegex": { + "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange": { + "description": "Range used to validate doubles and floats.", + "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange", + "properties": { + "max": { + "description": "The inclusive maximum of the acceptable range.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The inclusive minimum of the acceptable range.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange": { + "description": "Range used to validate longs and ints.", + "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange", + "properties": { + "max": { + "description": "The inclusive maximum of the acceptable range.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "The inclusive minimum of the acceptable range.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex": { + "description": "Rule used to validate strings.", + "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex", + "properties": { + "exclusive": { + "description": "Whether the regex matcher is applied exclusively (if true, matching values will be rejected).", + "type": "boolean" + }, + "regex": { + "description": "The regex applied to the input value(s).", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParameterEntry": { + "description": "Key-value pair of EventBus parameters.", + "id": "EnterpriseCrmEventbusProtoParameterEntry", + "properties": { + "key": { + "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.", + "type": "string" + }, + "value": { + "$ref": "EnterpriseCrmEventbusProtoParameterValueType", + "description": "Values for the defined keys. Each value can either be string, int, double or any proto message." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParameterMap": { + "description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.", + "id": "EnterpriseCrmEventbusProtoParameterMap", + "properties": { + "entries": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoParameterMapEntry" + }, + "type": "array" + }, + "keyType": { + "description": "Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + }, + "valueType": { + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParameterMapEntry": { + "description": "Entry is a pair of key and value.", + "id": "EnterpriseCrmEventbusProtoParameterMapEntry", + "properties": { + "key": { + "$ref": "EnterpriseCrmEventbusProtoParameterMapField" + }, + "value": { + "$ref": "EnterpriseCrmEventbusProtoParameterMapField" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParameterMapField": { + "description": "Field represents either the key or value in an entry.", + "id": "EnterpriseCrmEventbusProtoParameterMapField", + "properties": { + "literalValue": { + "$ref": "EnterpriseCrmEventbusProtoParameterValueType", + "description": "Passing a literal value." + }, + "referenceKey": { + "description": "Referencing one of the WF variables.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoParameterValueType": { + "description": "LINT.IfChange To support various types of parameter values. Next available id: 14", + "id": "EnterpriseCrmEventbusProtoParameterValueType", + "properties": { + "booleanArray": { + "$ref": "EnterpriseCrmEventbusProtoBooleanParameterArray" + }, + "booleanValue": { + "type": "boolean" + }, + "doubleArray": { + "$ref": "EnterpriseCrmEventbusProtoDoubleParameterArray" + }, + "doubleValue": { + "format": "double", + "type": "number" + }, + "intArray": { + "$ref": "EnterpriseCrmEventbusProtoIntParameterArray" + }, + "intValue": { + "format": "int64", + "type": "string" + }, + "protoArray": { + "$ref": "EnterpriseCrmEventbusProtoProtoParameterArray" + }, + "protoValue": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "serializedObjectValue": { + "$ref": "EnterpriseCrmEventbusProtoSerializedObjectParameter" + }, + "stringArray": { + "$ref": "EnterpriseCrmEventbusProtoStringParameterArray" + }, + "stringValue": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoPropertyEntry": { + "description": "Key-value pair of EventBus property.", + "id": "EnterpriseCrmEventbusProtoPropertyEntry", + "properties": { + "key": { + "description": "Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.", + "type": "string" + }, + "value": { + "$ref": "EnterpriseCrmEventbusProtoValueType", + "description": "Values for the defined keys. Each value can either be string, int, double or any proto message." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoProtoArrayFunction": { + "id": "EnterpriseCrmEventbusProtoProtoArrayFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "GET", + "APPEND", + "SIZE", + "TO_SET", + "APPEND_ALL", + "TO_JSON", + "SET", + "REMOVE", + "REMOVE_AT", + "CONTAINS", + "FOR_EACH", + "FILTER" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoProtoFunction": { + "id": "EnterpriseCrmEventbusProtoProtoFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "GET_STRING_SUBFIELD", + "GET_INT_SUBFIELD", + "GET_DOUBLE_SUBFIELD", + "GET_BOOLEAN_SUBFIELD", + "GET_STRING_ARRAY_SUBFIELD", + "GET_INT_ARRAY_SUBFIELD", + "GET_DOUBLE_ARRAY_SUBFIELD", + "GET_BOOLEAN_ARRAY_SUBFIELD", + "GET_PROTO_ARRAY_SUBFIELD", + "GET_PROTO_SUBFIELD", + "TO_JSON", + "GET_BYTES_SUBFIELD_AS_UTF_8_STRING", + "GET_BYTES_SUBFIELD_AS_PROTO", + "EQUALS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoProtoParameterArray": { + "id": "EnterpriseCrmEventbusProtoProtoParameterArray", + "properties": { + "protoValues": { + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoScatterResponse": { + "id": "EnterpriseCrmEventbusProtoScatterResponse", + "properties": { + "errorMsg": { + "description": "The error message of the failure if applicable.", + "type": "string" + }, + "executionIds": { + "description": "The execution ids of each Subworkflow fired by this scatter.", + "items": { + "type": "string" + }, + "type": "array" + }, + "isSuccessful": { + "description": "If execution is sync, this is true if the execution passed and false if it failed. If the execution is async, this is true if the WF was fired off successfully, and false if it failed to execute. The success or failure of the subworkflows executed are not captured.", + "type": "boolean" + }, + "responseParams": { + "description": "A list of all the response parameters in the aggregtorMap stored with the remapped key.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoParameterEntry" + }, + "type": "array" + }, + "scatterElement": { + "$ref": "EnterpriseCrmEventbusProtoParameterValueType", + "description": "The element that was scattered for this execution." + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSerializedObjectParameter": { + "id": "EnterpriseCrmEventbusProtoSerializedObjectParameter", + "properties": { + "objectValue": { + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoStringArray": { + "id": "EnterpriseCrmEventbusProtoStringArray", + "properties": { + "values": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoStringArrayFunction": { + "id": "EnterpriseCrmEventbusProtoStringArrayFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "GET", + "APPEND", + "SIZE", + "TO_SET", + "APPEND_ALL", + "TO_JSON", + "SET", + "REMOVE", + "REMOVE_AT", + "CONTAINS", + "FOR_EACH", + "FILTER" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoStringFunction": { + "id": "EnterpriseCrmEventbusProtoStringFunction", + "properties": { + "functionName": { + "enum": [ + "UNSPECIFIED", + "CONCAT", + "TO_UPPERCASE", + "TO_LOWERCASE", + "CONTAINS", + "SPLIT", + "LENGTH", + "EQUALS", + "TO_INT", + "TO_DOUBLE", + "TO_BOOLEAN", + "TO_BASE_64", + "TO_JSON", + "EQUALS_IGNORE_CASE", + "REPLACE_ALL", + "SUBSTRING", + "RESOLVE_TEMPLATE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoStringParameterArray": { + "id": "EnterpriseCrmEventbusProtoStringParameterArray", + "properties": { + "stringValues": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSuccessPolicy": { + "description": "Policy that dictates the behavior for the task after it completes successfully.", + "id": "EnterpriseCrmEventbusProtoSuccessPolicy", + "properties": { + "finalState": { + "description": "State to which the execution snapshot status will be set if the task succeeds.", + "enum": [ + "UNSPECIFIED", + "SUCCEEDED", + "SUSPENDED" + ], + "enumDescriptions": [ + "", + "The default behavior, where successful tasks will be marked as SUCCEEDED.", + "Sets the state to SUSPENDED after executing. This is required for SuspensionTask; event execution will continue once the user calls ResolveSuspensions with the event_execution_info_id and the task number." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSuspensionAuthPermissions": { + "description": "LINT.IfChange", + "id": "EnterpriseCrmEventbusProtoSuspensionAuthPermissions", + "properties": { + "gaiaIdentity": { + "$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity", + "description": "Represents a Gaia identity for a person or service account." + }, + "googleGroup": { + "$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity" + }, + "loasRole": { + "type": "string" + }, + "mdbGroup": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity": { + "id": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity", + "properties": { + "emailAddress": { + "type": "string" + }, + "gaiaId": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSuspensionConfig": { + "id": "EnterpriseCrmEventbusProtoSuspensionConfig", + "properties": { + "customMessage": { + "description": "Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.", + "type": "string" + }, + "notifications": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoNotification" + }, + "type": "array" + }, + "suspensionExpiration": { + "$ref": "EnterpriseCrmEventbusProtoSuspensionExpiration", + "description": "Indicates the next steps when no external actions happen on the suspension." + }, + "whoMayResolve": { + "description": "Identities able to resolve this suspension.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissions" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSuspensionExpiration": { + "id": "EnterpriseCrmEventbusProtoSuspensionExpiration", + "properties": { + "expireAfterMs": { + "description": "Milliseconds after which the suspension expires, if no action taken.", + "format": "int32", + "type": "integer" + }, + "liftWhenExpired": { + "description": "Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.", + "type": "boolean" + }, + "remindAfterMs": { + "description": "Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSuspensionResolutionInfo": { + "id": "EnterpriseCrmEventbusProtoSuspensionResolutionInfo", + "properties": { + "audit": { + "$ref": "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit" + }, + "createdTimestamp": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + }, + "eventExecutionInfoId": { + "description": "Required. ID of the associated execution.", + "type": "string" + }, + "externalTraffic": { + "$ref": "EnterpriseCrmEventbusProtoExternalTraffic", + "description": "The origin of the suspension for periodic notifications." + }, + "lastModifiedTimestamp": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + }, + "product": { + "description": "Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default.", + "enum": [ + "UNSPECIFIED_PRODUCT", + "IP", + "APIGEE", + "SECURITY" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "status": { + "enum": [ + "PENDING_UNSPECIFIED", + "REJECTED", + "LIFTED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "suspensionConfig": { + "$ref": "EnterpriseCrmEventbusProtoSuspensionConfig" + }, + "suspensionId": { + "description": "Primary key for the SuspensionResolutionInfoTable.", + "type": "string" + }, + "taskNumber": { + "description": "Required. Task number of the associated SuspensionTask.", + "type": "string" + }, + "workflowName": { + "description": "Required. The name of the originating workflow.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit": { + "id": "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit", + "properties": { + "resolvedBy": { + "type": "string" + }, + "timestamp": { + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTaskAlertConfig": { + "description": "Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.", + "id": "EnterpriseCrmEventbusProtoTaskAlertConfig", + "properties": { + "aggregationPeriod": { + "description": "The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).", + "type": "string" + }, + "alertDisabled": { + "description": "Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.", + "type": "boolean" + }, + "alertName": { + "description": "A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.", + "type": "string" + }, + "clientId": { + "description": "Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.", + "type": "string" + }, + "durationThresholdMs": { + "description": "Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.", + "format": "int64", + "type": "string" + }, + "errorEnumList": { + "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" + }, + "metricType": { + "enum": [ + "METRIC_TYPE_UNSPECIFIED", + "TASK_ERROR_RATE", + "TASK_WARNING_RATE", + "TASK_RATE", + "TASK_AVERAGE_DURATION", + "TASK_PERCENTILE_DURATION" + ], + "enumDescriptions": [ + "The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.", + "Specifies alerting on the rate of errors (potentially for a specific set of enum values) for the enclosing TaskConfig.", + "Specifies alerting on the rate of warnings (potentially for a specific set of enum values) for the enclosing TaskConfig. Warnings use the same enum values as errors.", + "Specifies alerting on the number of instances for the enclosing TaskConfig executed in the given aggregation_period.", + "Specifies alerting on the average duration of execution for the enclosing task.", + "Specifies alerting on the duration of a particular percentile of task executions. E.g. If 10% or more of the task executions have durations above 5 seconds, alert." + ], + "type": "string" + }, + "numAggregationPeriods": { + "description": "For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.", + "format": "int32", + "type": "integer" + }, + "onlyFinalAttempt": { + "description": "Only count final task attempts, not retries.", + "type": "boolean" + }, + "playbookUrl": { + "description": "Link to a playbook for resolving the issue that triggered this alert.", + "type": "string" + }, + "thresholdType": { + "description": "The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.", + "enum": [ + "UNSPECIFIED_THRESHOLD_TYPE", + "EXPECTED_MIN", + "EXPECTED_MAX" + ], + "enumDescriptions": [ + "", + "Note that this field will only trigger alerts if the workflow specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that `aggregation_period` for this alert configuration must be less than 24 hours.", + "" + ], + "type": "string" + }, + "thresholdValue": { + "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue", + "description": "The metric value, above or below which the alert should be triggered." + }, + "warningEnumList": { + "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTaskExecutionDetails": { + "description": "Contains the details of the execution of this task. Next available id: 11", + "id": "EnterpriseCrmEventbusProtoTaskExecutionDetails", + "properties": { + "taskAttemptStats": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats" + }, + "type": "array" + }, + "taskExecutionState": { + "enum": [ + "UNSPECIFIED", + "PENDING_EXECUTION", + "IN_PROCESS", + "SUCCEED", + "FAILED", + "FATAL", + "RETRY_ON_HOLD", + "SKIPPED", + "CANCELED", + "PENDING_ROLLBACK", + "ROLLBACK_IN_PROCESS", + "ROLLEDBACK", + "SUSPENDED" + ], + "enumDescriptions": [ + "", + "Task is waiting for its precondition tasks to finish to start the execution.", + "Task is under processing.", + "Task execution successfully finished. There's no more change after this state.", + "Task execution failed. There's no more change after this state.", + "Task execution failed and cause the whole event execution to fail immediately. There's no more change after this state.", + "Task execution failed and waiting for retry.", + "Task execution skipped. This happens when its precondition wasn't met, or the event execution been canceled before reach to the task. There's no more changes after this state.", + "Task execution canceled when in progress. This happens when event execution been canceled or any other task fall in fatal state.", + "Task is waiting for its dependency tasks' rollback to finish to start its rollback.", + "Task is rolling back.", + "Task is rolled back. This is the state we will set regardless of rollback succeeding or failing.", + "Task is a SuspensionTask which has executed once, creating a pending suspension." + ], + "type": "string" + }, + "taskNumber": { + "description": "Pointer to the task config it used for execution.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats": { + "id": "EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats", + "properties": { + "endTime": { + "description": "The end time of the task execution for current attempt.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "The start time of the task execution for current attempt. This could be in the future if it's been scheduled.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTaskMetadata": { + "description": "TaskMetadata are attributes that are associated to every common Task we have. Next available: 26", + "id": "EnterpriseCrmEventbusProtoTaskMetadata", + "properties": { + "activeTaskName": { + "description": "The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.", + "type": "string" + }, + "admins": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoTaskMetadataAdmin" + }, + "type": "array" + }, + "category": { + "enum": [ + "UNSPECIFIED_CATEGORY", + "CUSTOM", + "FLOW_CONTROL", + "DATA_MANIPULATION", + "SCRIPTING", + "CONNECTOR", + "HIDDEN", + "CLOUD_SYSTEMS", + "CUSTOM_TASK_TEMPLATE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "Internal IP tasks that should not be available in the UI.", + "Tasks that are relevant to cloud systems teams and typically", + "include connecting to Vector salesforce, CRM Hub Spanner etc. Task entities that derive from a custom task template." + ], + "type": "string" + }, + "codeSearchLink": { + "description": "The Code Search link to the Task Java file.", + "type": "string" + }, + "defaultJsonValidationOption": { + "description": "Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.", + "enum": [ + "UNSPECIFIED_JSON_VALIDATION_OPTION", + "SKIP", + "PRE_EXECUTION", + "POST_EXECUTION", + "PRE_POST_EXECUTION" + ], + "enumDescriptions": [ + "As per the default behavior, no validation will be run. Will not override any option set in a Task.", + "Do not run any validation against JSON schemas.", + "Validate all potential input JSON parameters against schemas specified in WorkflowParameters.", + "Validate all potential output JSON parameters against schemas specified in WorkflowParameters.", + "Perform both PRE_EXECUTION and POST_EXECUTION validations." + ], + "type": "string" + }, + "defaultSpec": { + "description": "Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.", + "type": "string" + }, + "description": { + "description": "In a few sentences, describe the purpose and usage of the task.", + "type": "string" + }, + "descriptiveName": { + "description": "The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. \"Send Mail\")", + "type": "string" + }, + "docMarkdown": { + "description": "Snippet of markdown documentation to embed in the RHP for this task.", + "type": "string" + }, + "externalCategory": { + "enum": [ + "UNSPECIFIED_EXTERNAL_CATEGORY", + "CORE", + "CONNECTORS" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "externalCategorySequence": { + "description": "Sequence with which the task in specific category to be displayed in task discovery panel for external users.", + "format": "int32", + "type": "integer" + }, + "externalDocHtml": { + "description": "External-facing documention embedded in the RHP for this task.", + "type": "string" + }, + "externalDocLink": { + "description": "Doc link for external-facing documentation (separate from g3doc).", + "type": "string" + }, + "externalDocMarkdown": { + "description": "DEPRECATED: Use external_doc_html.", + "type": "string" + }, + "g3DocLink": { + "description": "URL to the associated G3 Doc for the task if available", + "type": "string" + }, + "iconLink": { + "description": "URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.", + "type": "string" + }, + "isDeprecated": { + "description": "The deprecation status of the current task. Default value is false;", + "type": "boolean" + }, + "name": { + "description": "The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.", + "type": "string" + }, + "standaloneExternalDocHtml": { + "description": "External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html", + "type": "string" + }, + "status": { + "description": "Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.", + "enum": [ + "UNSPECIFIED_STATUS", + "DEFAULT_INACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "Default value. Actual Task Status should always be set to either INACTIVE or ACTIVE. If none is specified at runtime, it will be set to INACTIVE.", + "Still in-progress or incomplete, and not intended for use.", + "Available for use." + ], + "type": "string" + }, + "system": { + "enum": [ + "UNSPECIFIED_SYSTEM", + "GENERIC", + "BUGANIZER", + "SALESFORCE", + "CLOUD_SQL", + "PLX", + "SHEETS", + "GOOGLE_GROUPS", + "EMAIL", + "SPANNER", + "DATA_BRIDGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "tags": { + "description": "A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names (\"REST Caller\" vs. \"Call REST Endpoint\") or to help users find tasks based on related words.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTaskMetadataAdmin": { + "description": "Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.", + "id": "EnterpriseCrmEventbusProtoTaskMetadataAdmin", + "properties": { + "googleGroupEmail": { + "type": "string" + }, + "userEmail": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTaskUiConfig": { + "description": "Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework", + "id": "EnterpriseCrmEventbusProtoTaskUiConfig", + "properties": { + "taskUiModuleConfigs": { + "description": "Configurations of included config modules.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoTaskUiModuleConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTaskUiModuleConfig": { + "description": "Task author would use this type to configure a config module.", + "id": "EnterpriseCrmEventbusProtoTaskUiModuleConfig", + "properties": { + "moduleId": { + "description": "ID of the config module.", + "enum": [ + "UNSPECIFIED_TASK_MODULE", + "LABEL", + "ERROR_HANDLING", + "TASK_PARAM_TABLE", + "TASK_PARAM_FORM", + "PRECONDITION", + "SCRIPT_EDITOR", + "RPC", + "TASK_SUMMARY", + "SUSPENSION", + "RPC_TYPED", + "SUB_WORKFLOW", + "APPS_SCRIPT_NAVIGATOR", + "SUB_WORKFLOW_FOR_EACH_LOOP", + "FIELD_MAPPING", + "README", + "REST_CALLER", + "SUB_WORKFLOW_SCATTER_GATHER", + "CLOUD_SQL", + "GENERIC_CONNECTOR_TASK" + ], + "enumDescriptions": [ + "Default", + "Supports editing label of a task config.", + "Supports editing error handling settings such as retry strategy.", + "Supports adding, removing and editing task parameter values in a table with little assistance or restriction.", + "Supports editing values of declared input parameters of a task. Think of it as a \"strongly typed\" upgrade to the TASK_PARAM_TABLE.", + "Supports editing preconditions of a task config.", + "Supports adding, editing, and deleting the scripts associated with a script task, as well as modifying the input/output parameters.", + "Supports editing task parameters associated with an RPC/stubby task.", + "Contains readonly task information, including input/output type info.", + "Configures a SuspensionTask.", + "Configures a GenericStubbyTypedTask.", + "Configures a SubWorkflowExecutorTask.", + "Supports navigating to Apps Script editor", + "Configures a SubWorkflowForEachLoopTask.", + "Configures a FieldMappingTask.", + "Contains embedded in-product documentation for a task.", + "UI widget for the rest caller task.", + "Configures a SubWorkflowScatterGatherTask.", + "Configures a CloudSql Task.", + "Configure a GenericConnectorTask." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTeardown": { + "id": "EnterpriseCrmEventbusProtoTeardown", + "properties": { + "teardownTaskConfigs": { + "description": "Required.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoTeardownTaskConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTeardownTaskConfig": { + "id": "EnterpriseCrmEventbusProtoTeardownTaskConfig", + "properties": { + "creatorEmail": { + "description": "The creator's email address.", + "type": "string" + }, + "name": { + "description": "Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.", + "type": "string" + }, + "nextTeardownTask": { + "$ref": "EnterpriseCrmEventbusProtoNextTeardownTask" + }, + "parameters": { + "$ref": "EnterpriseCrmEventbusProtoEventParameters", + "description": "The parameters the user can pass to this task." + }, + "properties": { + "$ref": "EnterpriseCrmEventbusProtoEventBusProperties" + }, + "teardownTaskImplementationClassName": { + "description": "Required. Implementation class name.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoToken": { + "id": "EnterpriseCrmEventbusProtoToken", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTransformExpression": { + "id": "EnterpriseCrmEventbusProtoTransformExpression", + "properties": { + "initialValue": { + "$ref": "EnterpriseCrmEventbusProtoBaseValue", + "description": "Initial value upon which to perform transformations." + }, + "transformationFunctions": { + "description": "Transformations to be applied sequentially.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoFunction" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoTriggerCriteria": { + "id": "EnterpriseCrmEventbusProtoTriggerCriteria", + "properties": { + "condition": { + "description": "Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.", + "type": "string" + }, + "parameters": { + "$ref": "EnterpriseCrmEventbusProtoEventParameters", + "description": "Optional. To be used in TaskConfig for the implementation class." + }, + "triggerCriteriaTaskImplementationClassName": { + "description": "Optional. Implementation class name. The class should implement the \u201cTypedTask\u201d interface.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoValueType": { + "description": "Used for define type for values. Currently supported value types include int, string, double, array, and any proto message.", + "id": "EnterpriseCrmEventbusProtoValueType", + "properties": { + "booleanValue": { + "type": "boolean" + }, + "doubleArray": { + "$ref": "EnterpriseCrmEventbusProtoDoubleArray" + }, + "doubleValue": { + "format": "double", + "type": "number" + }, + "intArray": { + "$ref": "EnterpriseCrmEventbusProtoIntArray" + }, + "intValue": { + "format": "int64", + "type": "string" + }, + "protoValue": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "stringArray": { + "$ref": "EnterpriseCrmEventbusProtoStringArray" + }, + "stringValue": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusProtoWorkflowAlertConfig": { + "description": "Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.", + "id": "EnterpriseCrmEventbusProtoWorkflowAlertConfig", + "properties": { + "aggregationPeriod": { + "description": "For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.", + "type": "string" + }, + "alertDisabled": { + "description": "Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.", + "type": "boolean" + }, + "alertName": { + "description": "A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.", + "type": "string" + }, + "clientId": { + "description": "Client associated with this alert configuration.", + "type": "string" + }, + "durationThresholdMs": { + "description": "Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.", + "format": "int64", + "type": "string" + }, + "errorEnumList": { + "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" + }, + "metricType": { + "enum": [ + "METRIC_TYPE_UNSPECIFIED", + "EVENT_ERROR_RATE", + "EVENT_WARNING_RATE", + "TASK_ERROR_RATE", + "TASK_WARNING_RATE", + "TASK_RATE", + "EVENT_RATE", + "EVENT_AVERAGE_DURATION", + "EVENT_PERCENTILE_DURATION", + "TASK_AVERAGE_DURATION", + "TASK_PERCENTILE_DURATION" + ], + "enumDescriptions": [ + "The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.", + "Specifies alerting on the rate of errors for the enclosing workflow.", + "Specifies alerting on the rate of warnings for the enclosing workflow. Warnings use the same enum values as errors.", + "Specifies alerting on the rate of errors for any task in the enclosing workflow.", + "Specifies alerting on the rate of warnings for any task in the enclosing workflow.", + "Specifies alerting on the rate of executions over all tasks in the enclosing workflow.", + "Specifies alerting on the number of events executed in the given aggregation_period.", + "Specifies alerting on the average duration of executions for this workflow.", + "Specifies alerting on the duration value of a particular percentile of workflow executions. E.g. If 10% or more of the workflow executions have durations above 5 seconds, alert.", + "Specifies alerting on the average duration of any task in the enclosing workflow,", + "Specifies alerting on the duration value of a particular percentile of any task executions within the enclosing workflow. E.g. If 10% or more of the task executions in the workflow have durations above 5 seconds, alert." + ], + "type": "string" + }, + "numAggregationPeriods": { + "description": "For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.", + "format": "int32", + "type": "integer" + }, + "onlyFinalAttempt": { + "description": "For either events or tasks, depending on the type of alert, count only final attempts, not retries.", + "type": "boolean" + }, + "playbookUrl": { + "description": "Link to a playbook for resolving the issue that triggered this alert.", + "type": "string" + }, + "thresholdType": { + "description": "The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.", + "enum": [ + "UNSPECIFIED_THRESHOLD_TYPE", + "EXPECTED_MIN", + "EXPECTED_MAX" + ], + "enumDescriptions": [ + "", + "Note that this field will only trigger alerts if the workflow specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that `aggregation_period` for this alert configuration must be less than 24 hours.", + "" + ], + "type": "string" + }, + "thresholdValue": { + "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue", + "description": "The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples." + }, + "warningEnumList": { + "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusStats": { + "description": "Stats for the requested dimensions: QPS, duration, and error/warning rate", + "id": "EnterpriseCrmEventbusStats", + "properties": { + "dimensions": { + "$ref": "EnterpriseCrmEventbusStatsDimensions", + "description": "Dimensions that these stats have been aggregated on." + }, + "durationInSeconds": { + "description": "Average duration in seconds.", + "format": "double", + "type": "number" + }, + "errorRate": { + "description": "Average error rate.", + "format": "double", + "type": "number" + }, + "qps": { + "description": "Queries per second.", + "format": "double", + "type": "number" + }, + "warningRate": { + "description": "Average warning rate.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "EnterpriseCrmEventbusStatsDimensions": { + "id": "EnterpriseCrmEventbusStatsDimensions", + "properties": { + "clientId": { + "type": "string" + }, + "enumFilterType": { + "description": "Whether to include or exclude the enums matching the regex.", + "enum": [ + "DEFAULT_INCLUSIVE", + "EXCLUSIVE" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "errorEnumString": { + "type": "string" + }, + "retryAttempt": { + "enum": [ + "UNSPECIFIED", + "FINAL", + "RETRYABLE", + "CANCELED" + ], + "enumDescriptions": [ + "", + "Task has completed successfully or has depleted all retry attempts.", + "Task has failed but may be retried.", + "Task has been deliberately canceled." + ], + "type": "string" + }, + "taskName": { + "type": "string" + }, + "taskNumber": { + "type": "string" + }, + "triggerId": { + "description": "Stats have been or will be aggregated on set fields for any semantically-meaningful combination.", + "type": "string" + }, + "warningEnumString": { + "type": "string" + }, + "workflowId": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray": { + "id": "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray", + "properties": { + "booleanValues": { + "items": { + "type": "boolean" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray": { + "id": "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray", + "properties": { + "doubleValues": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails": { + "description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10", + "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails", + "properties": { + "eventAttemptStats": { + "items": { + "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats" + }, + "type": "array" + }, + "eventExecutionSnapshot": { + "description": "After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot" + }, + "type": "array" + }, + "eventExecutionState": { + "description": "The execution state of this event.", + "enum": [ + "UNSPECIFIED", + "ON_HOLD", + "IN_PROCESS", + "SUCCEEDED", + "FAILED", + "CANCELED", + "RETRY_ON_HOLD", + "SUSPENDED" + ], + "enumDescriptions": [ + "", + "Event is received and waiting for the execution. This happens when firing the event via \"postToQueue\" or \"schedule\".", + "Event is under processing.", + "Event execution successfully finished. There's no more change after this state.", + "Event execution failed. There's no more change after this state.", + "Event execution canceled by user. There's no more change after this state.", + "Event execution failed and waiting for retry.", + "Event execution suspended and waiting for manual intervention." + ], + "type": "string" + }, + "eventRetriesFromBeginningCount": { + "description": "Indicates the number of times the execution has restarted from the beginning.", + "format": "int32", + "type": "integer" + }, + "logFilePath": { + "description": "The log file path (aka. cns address) for this event.", + "type": "string" + }, + "networkAddress": { + "description": "The network address (aka. bns address) that indicates where the event executor is running.", + "type": "string" + }, + "nextExecutionTime": { + "description": "Next scheduled execution time in case the execution status was RETRY_ON_HOLD.", + "format": "int64", + "type": "string" + }, + "ryeLockUnheldCount": { + "description": "Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo": { + "description": "Contains all the execution details for a workflow instance. Next available id: 24", + "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo", + "properties": { + "clientId": { + "description": "The event data user sends as request.", + "type": "string" + }, + "createTime": { + "description": "Auto-generated.", + "format": "int64", + "type": "string" + }, + "errorCode": { + "$ref": "CrmlogErrorCode", + "description": "Final error-code if event failed." + }, + "errors": { + "description": "Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoErrorDetail" + }, + "type": "array" + }, + "eventExecutionDetails": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails", + "description": "The execution info about this event." + }, + "eventExecutionInfoId": { + "description": "Auto-generated primary key.", + "type": "string" + }, + "executionTraceInfo": { + "$ref": "EnterpriseCrmEventbusProtoExecutionTraceInfo", + "description": "Execution trace info to aggregate parent-child executions." + }, + "lastModifiedTime": { + "description": "Auto-generated.", + "format": "int64", + "type": "string" + }, + "postMethod": { + "description": "The ways user posts this event.", + "enum": [ + "UNSPECIFIED", + "POST", + "POST_TO_QUEUE", + "SCHEDULE", + "POST_BY_EVENT_CONFIG_ID", + "POST_WITH_EVENT_DETAILS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "product": { + "description": "Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default.", + "enum": [ + "UNSPECIFIED_PRODUCT", + "IP", + "APIGEE", + "SECURITY" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "requestId": { + "description": "Optional. This is used to de-dup incoming request.", + "type": "string" + }, + "requestParams": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "description": "Event parameters come in as part of the request." + }, + "responseParams": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "description": "Event parameters come out as part of the response." + }, + "snapshotNumber": { + "description": "Workflow snapshot number.", + "format": "int64", + "type": "string" + }, + "tenant": { + "description": "Tenant this event is created. Used to reschedule the event to correct tenant.", + "type": "string" + }, + "triggerId": { + "description": "The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.", + "type": "string" + }, + "workflowId": { + "description": "Required. Pointer to the workflow it is executing.", + "type": "string" + }, + "workflowName": { + "description": "Name of the workflow.", + "type": "string" + }, + "workflowRetryBackoffIntervalSeconds": { + "description": "Time interval in seconds to schedule retry of workflow in manifold when workflow is already running", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot": { + "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot", + "properties": { + "checkpointTaskNumber": { + "description": "Indicates \"right after which checkpoint task's execution\" this snapshot is taken.", + "type": "string" + }, + "conditionResults": { + "description": "All of the computed conditions that been calculated.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoConditionResult" + }, + "type": "array" + }, + "diffParams": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "description": "The parameters in Event object that differs from last snapshot." + }, + "eventExecutionInfoId": { + "description": "Points to the event execution info this snapshot belongs to.", + "type": "string" + }, + "eventExecutionSnapshotId": { + "description": "Auto-generated. Used as primary key for EventExecutionSnapshots table.", + "type": "string" + }, + "eventExecutionSnapshotMetadata": { + "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata" + }, + "eventParams": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "description": "The parameters in Event object." + }, + "snapshotTime": { + "description": "Indicates when this snapshot is taken.", + "format": "int64", + "type": "string" + }, + "taskExecutionDetails": { + "description": "All of the task execution details at the given point of time.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoTaskExecutionDetails" + }, + "type": "array" + }, + "taskName": { + "description": "The task name associated with this snapshot. Could be empty.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoEventParameters": { + "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4", + "id": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "properties": { + "parameters": { + "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoIntParameterArray": { + "id": "EnterpriseCrmFrontendsEventbusProtoIntParameterArray", + "properties": { + "intValues": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoParamSpecEntry": { + "description": "Key-value pair of EventBus task parameters. Next id: 13", + "id": "EnterpriseCrmFrontendsEventbusProtoParamSpecEntry", + "properties": { + "className": { + "description": "The FQCN of the Java object this represents. A string, for example, would be \"java.lang.String\". If this is \"java.lang.Object\", the parameter can be of any type.", + "type": "string" + }, + "collectionElementClassName": { + "description": "If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is \"java.lang.Object\", the parameter is a collection of any type.", + "type": "string" + }, + "config": { + "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryConfig", + "description": "Optional fields, such as help text and other useful info." + }, + "dataType": { + "description": "The data type of the parameter.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + }, + "defaultValue": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", + "description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." + }, + "isDeprecated": { + "description": "If set, this entry is deprecated, so further use of this parameter should be prohibited.", + "type": "boolean" + }, + "isOutput": { + "type": "boolean" + }, + "jsonSchema": { + "description": "If the data_type is JSON_VALUE, then this will define its schema.", + "type": "string" + }, + "key": { + "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.", + "type": "string" + }, + "protoDef": { + "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition", + "description": "Populated if this represents a proto or proto array." + }, + "required": { + "description": "If set, the user must provide an input value for this parameter.", + "type": "boolean" + }, + "validationRule": { + "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRule", + "description": "Rule used to validate inputs (individual values and collection elements) for this parameter." + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage": { + "id": "EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage", + "properties": { + "parameters": { + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParamSpecEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoParameterEntry": { + "description": "Key-value pair of EventBus parameters.", + "id": "EnterpriseCrmFrontendsEventbusProtoParameterEntry", + "properties": { + "dataType": { + "description": "Explicitly getting the type of the parameter.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + }, + "key": { + "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.", + "type": "string" + }, + "value": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", + "description": "Values for the defined keys. Each value can either be string, int, double or any proto message." + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoParameterMap": { + "description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.", + "id": "EnterpriseCrmFrontendsEventbusProtoParameterMap", + "properties": { + "entries": { + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry" + }, + "type": "array" + }, + "keyType": { + "description": "Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + }, + "valueType": { + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry": { + "description": "Entry is a pair of key and value.", + "id": "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry", + "properties": { + "key": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapField" + }, + "value": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapField" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoParameterMapField": { + "description": "Field represents either the key or value in an entry.", + "id": "EnterpriseCrmFrontendsEventbusProtoParameterMapField", + "properties": { + "literalValue": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", + "description": "Passing a literal value." + }, + "referenceKey": { + "description": "Referencing one of the WF variables.", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoParameterValueType": { + "description": "To support various types of parameter values. Next available id: 14", + "id": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", + "properties": { + "booleanArray": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray" + }, + "booleanValue": { + "type": "boolean" + }, + "doubleArray": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray" + }, + "doubleValue": { + "format": "double", + "type": "number" + }, + "intArray": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoIntParameterArray" + }, + "intValue": { + "format": "int64", + "type": "string" + }, + "jsonValue": { + "type": "string" + }, + "protoArray": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray" + }, + "protoValue": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "serializedObjectValue": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter" + }, + "stringArray": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoStringParameterArray" + }, + "stringValue": { + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray": { + "id": "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray", + "properties": { + "protoValues": { + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoRollbackStrategy": { + "description": "Next available id: 4", + "id": "EnterpriseCrmFrontendsEventbusProtoRollbackStrategy", + "properties": { + "parameters": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "description": "Optional. The customized parameters the user can pass to this task." + }, + "rollbackTaskImplementationClassName": { + "description": "Required. This is the name of the task that needs to be executed upon rollback of this task.", + "type": "string" + }, + "taskNumbersToRollback": { + "description": "Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter": { + "id": "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter", + "properties": { + "objectValue": { + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoStringParameterArray": { + "id": "EnterpriseCrmFrontendsEventbusProtoStringParameterArray", + "properties": { + "stringValues": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoTaskConfig": { + "description": "The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27", + "id": "EnterpriseCrmFrontendsEventbusProtoTaskConfig", + "properties": { + "alertConfigs": { + "description": "Alert configurations on error rate, warning rate, number of runs, durations, etc.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoTaskAlertConfig" + }, + "type": "array" + }, + "createTime": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + }, + "creatorEmail": { + "description": "The creator's email address. Auto-generated from the user's email.", + "type": "string" + }, + "description": { + "description": "User-provided description intended to give more business context about the task.", + "type": "string" + }, + "disableStrictTypeValidation": { + "description": "If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.", + "type": "boolean" + }, + "failurePolicy": { + "$ref": "EnterpriseCrmEventbusProtoFailurePolicy", + "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.)." + }, + "incomingEdgeCount": { + "description": "The number of edges leading into this TaskConfig.", + "format": "int32", + "type": "integer" + }, + "jsonValidationOption": { + "description": "If set, overrides the option configured in the Task implementation class.", + "enum": [ + "UNSPECIFIED_JSON_VALIDATION_OPTION", + "SKIP", + "PRE_EXECUTION", + "POST_EXECUTION", + "PRE_POST_EXECUTION" + ], + "enumDescriptions": [ + "As per the default behavior, no validation will be run. Will not override any option set in a Task.", + "Do not run any validation against JSON schemas.", + "Validate all potential input JSON parameters against schemas specified in WorkflowParameters.", + "Validate all potential output JSON parameters against schemas specified in WorkflowParameters.", + "Perform both PRE_EXECUTION and POST_EXECUTION validations." + ], + "type": "string" + }, + "label": { + "description": "User-provided label that is attached to this TaskConfig in the UI.", + "type": "string" + }, + "lastModifiedTime": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + }, + "nextTasks": { + "description": "The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoNextTask" + }, + "type": "array" + }, + "nextTasksExecutionPolicy": { + "description": "The policy dictating the execution of the next set of tasks for the current task.", + "enum": [ + "UNSPECIFIED", + "RUN_ALL_MATCH", + "RUN_FIRST_MATCH" + ], + "enumDescriptions": [ + "Default", + "Execute all the tasks that satisfy their associated condition.", + "Execute the first task that satisfies the associated condition." + ], + "type": "string" + }, + "parameters": { + "additionalProperties": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" + }, + "description": "The customized parameters the user can pass to this task.", + "type": "object" + }, + "position": { + "$ref": "EnterpriseCrmEventbusProtoCoordinate", + "description": "Optional. Informs the front-end application where to draw this task config on the UI." + }, + "precondition": { + "description": "Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. \"rollout(5)\" will only allow 5% of incoming traffic to task.", + "type": "string" + }, + "preconditionLabel": { + "description": "Optional. User-provided label that is attached to precondition in the UI.", + "type": "string" + }, + "rollbackStrategy": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoRollbackStrategy", + "description": "Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times)." + }, + "successPolicy": { + "$ref": "EnterpriseCrmEventbusProtoSuccessPolicy", + "description": "Determines what action to take upon successful task completion." + }, + "synchronousCallFailurePolicy": { + "$ref": "EnterpriseCrmEventbusProtoFailurePolicy", + "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post)." + }, + "taskEntity": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskEntity", + "description": "Copy of the task entity that this task config is an instance of." + }, + "taskExecutionStrategy": { + "description": "The policy dictating the execution strategy of this task.", + "enum": [ + "WHEN_ALL_SUCCEED", + "WHEN_ANY_SUCCEED", + "WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED" + ], + "enumDescriptions": [ + "Wait until all of its previous tasks finished execution, then verify at least one of the edge conditions is met, and execute if possible. This should be considered as WHEN_ALL_TASKS_SUCCEED.", + "Start execution as long as any of its previous tasks finished execution and the corresponding edge condition is met (since we will execute if only that succeeding edge condition is met).", + "Wait until all of its previous tasks finished execution, then verify the all edge conditions are met and execute if possible." + ], + "type": "string" + }, + "taskName": { + "description": "The name for the task.", + "type": "string" + }, + "taskNumber": { + "description": "REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).", + "type": "string" + }, + "taskSpec": { + "description": "A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old \"parameters\" field. Please refer to go/eventbus-task-spec-example for detailed usage example.", + "type": "string" + }, + "taskTemplateName": { + "description": "Used to define task-template name if task is of type task-template", + "type": "string" + }, + "taskType": { + "description": "Defines the type of the task", + "enum": [ + "TASK", + "ASIS_TEMPLATE", + "IO_TEMPLATE" + ], + "enumDescriptions": [ + "Normal IP task", + "Task is of As-Is Template type", + "Task is of I/O template type with a different underlying task" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoTaskEntity": { + "description": "Contains a task's metadata and associated information. Next available id: 7", + "id": "EnterpriseCrmFrontendsEventbusProtoTaskEntity", + "properties": { + "disabledForVpcSc": { + "description": "True if the task has conflict with vpcsc", + "type": "boolean" + }, + "metadata": { + "$ref": "EnterpriseCrmEventbusProtoTaskMetadata", + "description": "Metadata inclueds the task name, author and so on." + }, + "paramSpecs": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage", + "description": "Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask." + }, + "stats": { + "$ref": "EnterpriseCrmEventbusStats", + "description": "Deprecated - statistics from the Monarch query." + }, + "taskType": { + "description": "Defines the type of the task", + "enum": [ + "TASK", + "ASIS_TEMPLATE", + "IO_TEMPLATE" + ], + "enumDescriptions": [ + "Normal IP task", + "Task is of As-Is Template type", + "Task is of I/O template type with a different underlying task" + ], + "type": "string" + }, + "uiConfig": { + "$ref": "EnterpriseCrmEventbusProtoTaskUiConfig", + "description": "UI configuration for this task Also associated with the METADATA mask." + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoTriggerConfig": { + "description": "Configuration detail of a trigger. Next available id: 16", + "id": "EnterpriseCrmFrontendsEventbusProtoTriggerConfig", + "properties": { + "alertConfig": { + "description": "An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoWorkflowAlertConfig" + }, + "type": "array" + }, + "description": { + "description": "User-provided description intended to give more business context about the task.", + "type": "string" + }, + "enabledClients": { + "description": "Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.", + "items": { + "type": "string" + }, + "type": "array" + }, + "label": { + "description": "The user created label for a particular trigger.", + "type": "string" + }, + "nextTasksExecutionPolicy": { + "description": "Dictates how next tasks will be executed.", + "enum": [ + "UNSPECIFIED", + "RUN_ALL_MATCH", + "RUN_FIRST_MATCH" + ], + "enumDescriptions": [ + "Default", + "Execute all the tasks that satisfy their associated condition.", + "Execute the first task that satisfies the associated condition." + ], + "type": "string" + }, + "pauseWorkflowExecutions": { + "description": "Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.", + "type": "boolean" + }, + "position": { + "$ref": "EnterpriseCrmEventbusProtoCoordinate", + "description": "Optional. Informs the front-end application where to draw this trigger config on the UI." + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Configurable properties of the trigger, not to be confused with workflow parameters. E.g. \"name\" is a property for API triggers and \"subscription\" is a property for Cloud Pubsub triggers.", + "type": "object" + }, + "startTasks": { + "description": "Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).", + "items": { + "$ref": "EnterpriseCrmEventbusProtoNextTask" + }, + "type": "array" + }, + "triggerCriteria": { + "$ref": "EnterpriseCrmEventbusProtoTriggerCriteria", + "description": "Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true." + }, + "triggerId": { + "description": "The backend trigger ID.", + "type": "string" + }, + "triggerNumber": { + "description": "Required. A number to uniquely identify each trigger config within the workflow on UI.", + "type": "string" + }, + "triggerType": { + "enum": [ + "UNKNOWN", + "CLOUD_PUBSUB", + "GOOPS", + "SFDC_SYNC", + "CRON", + "API", + "MANIFOLD_TRIGGER", + "DATALAYER_DATA_CHANGE", + "SFDC_CHANNEL", + "CLOUD_PUBSUB_EXTERNAL", + "SFDC_CDC_CHANNEL", + "SFDC_PLATFORM_EVENTS_CHANNEL" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry": { + "id": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry", + "properties": { + "attributes": { + "$ref": "EnterpriseCrmEventbusProtoAttributes", + "description": "Metadata information about the parameters." + }, + "children": { + "description": "Child parameters nested within this parameter. This field only applies to protobuf parameters", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry" + }, + "type": "array" + }, + "dataType": { + "description": "The data type of the parameter.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "PROTO_VALUE", + "SERIALIZED_OBJECT_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "PROTO_ARRAY", + "PROTO_ENUM", + "BOOLEAN_ARRAY", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY", + "NON_SERIALIZABLE_OBJECT", + "JSON_VALUE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "", + "", + "" + ], + "type": "string" + }, + "defaultValue": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", + "description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." + }, + "inOutType": { + "description": "Specifies the input/output type for the parameter.", + "enum": [ + "IN_OUT_TYPE_UNSPECIFIED", + "IN", + "OUT", + "IN_OUT" + ], + "enumDescriptions": [ + "", + "Input parameters for the workflow. EventBus validates that these parameters exist in the workflows before execution.", + "Output Parameters for the workflow. EventBus will only return the workflow parameters tagged with OUT in the response back.", + "Input or Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response." + ], + "type": "string" + }, + "isTransient": { + "description": "Whether this parameter is a transient parameter. go/ip-transient-parameters", + "type": "boolean" + }, + "jsonSchema": { + "description": "This schema will be used to validate runtime JSON-typed values of this parameter.", + "type": "string" + }, + "key": { + "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.", + "type": "string" + }, + "name": { + "description": "The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\".", + "type": "string" + }, + "producedBy": { + "$ref": "EnterpriseCrmEventbusProtoNodeIdentifier", + "description": "The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param." + }, + "producer": { + "type": "string" + }, + "protoDefName": { + "description": "The name of the protobuf type if the parameter has a protobuf data type.", + "type": "string" + }, + "protoDefPath": { + "description": "If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be \"enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry\".", + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters": { + "description": "LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as \"children\" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters.", + "id": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters", + "properties": { + "parameters": { + "description": "Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "EnterpriseCrmLoggingGwsFieldLimits": { + "description": "Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6", + "id": "EnterpriseCrmLoggingGwsFieldLimits", + "properties": { + "logAction": { + "enum": [ + "LOG_ACTION_UNSPECIFIED", + "DONT_LOG", + "LOG" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "logType": { + "description": "To which type(s) of logs the limits apply.", + "items": { + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "GWS", + "GTS", + "ALL" + ], + "enumDescriptions": [ + "", + "Limits apply when log detail records are written to GWS.", + "Limits apply when log detail records are written to GTS (e.g., RecordIO files).", + "Limits apply to *all* output log types." + ], + "type": "string" + }, + "type": "array" + }, + "maxArraySize": { + "description": "maximum array size. If the array exceds this size, the field (list) is truncated.", + "format": "int32", + "type": "integer" + }, + "maxStringLength": { + "description": "maximum string length. If the field exceeds this amount the field is shortened.", + "format": "int32", + "type": "integer" + }, + "shortenerType": { + "enum": [ + "SHORTENER_TYPE_UNSPECIFIED", + "SHORTEN", + "HASH", + "SHORTEN_WITH_HASH", + "SHORTEN_EMAIL", + "SHORTEN_EMAIL_WITH_HASH", + "SHORTEN_DOMAIN" + ], + "enumDescriptions": [ + "", + "String is shortened to max_string_length.", + "String is replaced by its hex-string hash.", + "String is replaced by a combination of string shortening and a hex-string hash.", + "String shortening for email addresses. Shortening may be done on the user and/or domain portion of the email address.", + "String is replaced by a combination of string shortening and a hex-string hash for an email address.", + "Shortens a domain name (e.g., as part of an email address or URL)." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnterpriseCrmLoggingGwsSanitizeOptions": { + "description": "Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5", + "id": "EnterpriseCrmLoggingGwsSanitizeOptions", + "properties": { + "isAlreadySanitized": { + "description": "If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.", + "type": "boolean" + }, + "logType": { + "description": "To which type(s) of logs the sanitize options apply.", + "items": { + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "GWS", + "GTS", + "ALL" + ], + "enumDescriptions": [ + "", + "Limits apply when log detail records are written to GWS.", + "Limits apply when log detail records are written to GTS (e.g., RecordIO files).", + "Limits apply to *all* output log types." + ], + "type": "string" + }, + "type": "array" + }, + "privacy": { + "enum": [ + "PRIVACY_TYPE_UNSPECIFIED", + "NOT_PII", + "PII", + "SPII", + "UNSURE" + ], + "enumDescriptions": [ + "", + "Field does *NOT* contain PII or sensitive data.", + "Field contains PII.", + "Field contains Sensitive PII.", + "Unsure if field contains PII." + ], + "type": "string" + }, + "sanitizeType": { + "enum": [ + "SANITIZE_TYPE_UNSPECIFIED", + "SCRUB", + "ANONYMIZE", + "ANONYMIZE_LIMITED_REPEATABLE", + "OBFUSCATE", + "ENCRYPT", + "DO_NOT_SANITIZE" + ], + "enumDescriptions": [ + "", + "Replace value with a scrubbed value (usu. a constant).", + "Transform a value so that it cannot be tracked across events. However, a given value, is transformed to the same value *within* an event. E.g., \"foo.com\" is transformed to \"0xabcdef\" for event 1001, and to \"0xfedcba\" for event 1002.", + "Transform values as with ANONYMIZER, but the same transformation is repeated for a limited time (e.g., 1 day).", + "The value is transformed using a well-defined obfuscator (e.g., D3_CUSTOMER_ID).", + "The value is encrypted.", + "No sanitization is required." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1AuthConfig": { + "description": "AuthConfig defines details of a authentication type.", + "id": "GoogleCloudConnectorsV1AuthConfig", + "properties": { + "additionalVariables": { + "description": "List containing additional auth configs.", + "items": { + "$ref": "GoogleCloudConnectorsV1ConfigVariable" + }, + "type": "array" + }, + "authType": { + "description": "The type of authentication configured.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "USER_PASSWORD", + "OAUTH2_JWT_BEARER", + "OAUTH2_CLIENT_CREDENTIALS", + "SSH_PUBLIC_KEY", + "OAUTH2_AUTH_CODE_FLOW" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "Username and Password Authentication.", + "JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication", + "Oauth 2.0 Client Credentials Grant Authentication", + "SSH Public Key Authentication", + "Oauth 2.0 Authorization Code Flow" + ], + "type": "string" + }, + "oauth2ClientCredentials": { + "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", + "description": "Oauth2ClientCredentials." + }, + "oauth2JwtBearer": { + "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer", + "description": "Oauth2JwtBearer." + }, + "sshPublicKey": { + "$ref": "GoogleCloudConnectorsV1AuthConfigSshPublicKey", + "description": "SSH Public Key." + }, + "userPassword": { + "$ref": "GoogleCloudConnectorsV1AuthConfigUserPassword", + "description": "UserPassword." + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials": { + "description": "Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.", + "id": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", + "properties": { + "clientId": { + "description": "The client identifier.", + "type": "string" + }, + "clientSecret": { + "$ref": "GoogleCloudConnectorsV1Secret", + "description": "Secret version reference containing the client secret." + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer": { + "description": "Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.", + "id": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer", + "properties": { + "clientKey": { + "$ref": "GoogleCloudConnectorsV1Secret", + "description": "Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`." + }, + "jwtClaims": { + "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims", + "description": "JwtClaims providers fields to generate the token." + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims": { + "description": "JWT claims used for the jwt-bearer authorization grant.", + "id": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims", + "properties": { + "audience": { + "description": "Value for the \"aud\" claim.", + "type": "string" + }, + "issuer": { + "description": "Value for the \"iss\" claim.", + "type": "string" + }, + "subject": { + "description": "Value for the \"sub\" claim.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1AuthConfigSshPublicKey": { + "description": "Parameters to support Ssh public key Authentication.", + "id": "GoogleCloudConnectorsV1AuthConfigSshPublicKey", + "properties": { + "certType": { + "description": "Format of SSH Client cert.", + "type": "string" + }, + "password": { + "$ref": "GoogleCloudConnectorsV1Secret", + "description": "This is an optional field used in case client has enabled multi-factor authentication" + }, + "sshClientCert": { + "$ref": "GoogleCloudConnectorsV1Secret", + "description": "SSH Client Cert. It should contain both public and private key." + }, + "sshClientCertPass": { + "$ref": "GoogleCloudConnectorsV1Secret", + "description": "Password (passphrase) for ssh client certificate if it has one." + }, + "username": { + "description": "The user account used to authenticate.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1AuthConfigUserPassword": { + "description": "Parameters to support Username and Password Authentication.", + "id": "GoogleCloudConnectorsV1AuthConfigUserPassword", + "properties": { + "password": { + "$ref": "GoogleCloudConnectorsV1Secret", + "description": "Secret version reference containing the password." + }, + "username": { + "description": "Username.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1ConfigVariable": { + "description": "ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.", + "id": "GoogleCloudConnectorsV1ConfigVariable", + "properties": { + "boolValue": { + "description": "Value is a bool.", + "type": "boolean" + }, + "intValue": { + "description": "Value is an integer", + "format": "int64", + "type": "string" + }, + "key": { + "description": "Key of the config variable.", + "type": "string" + }, + "secretValue": { + "$ref": "GoogleCloudConnectorsV1Secret", + "description": "Value is a secret." + }, + "stringValue": { + "description": "Value is a string.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1Connection": { + "description": "Connection represents an instance of connector.", + "id": "GoogleCloudConnectorsV1Connection", + "properties": { + "authConfig": { + "$ref": "GoogleCloudConnectorsV1AuthConfig", + "description": "Optional. Configuration for establishing the connection's authentication with an external system." + }, + "configVariables": { + "description": "Optional. Configuration for configuring the connection with an external system.", + "items": { + "$ref": "GoogleCloudConnectorsV1ConfigVariable" + }, + "type": "array" + }, + "connectorVersion": { + "description": "Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.", + "type": "string" + }, + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the resource.", + "type": "string" + }, + "destinationConfigs": { + "description": "Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).", + "items": { + "$ref": "GoogleCloudConnectorsV1DestinationConfig" + }, + "type": "array" + }, + "envoyImageLocation": { + "description": "Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}", + "readOnly": true, + "type": "string" + }, + "imageLocation": { + "description": "Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources", + "type": "object" + }, + "lockConfig": { + "$ref": "GoogleCloudConnectorsV1LockConfig", + "description": "Optional. Configuration that indicates whether or not the Connection can be edited." + }, + "name": { + "description": "Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}", + "readOnly": true, + "type": "string" + }, + "nodeConfig": { + "$ref": "GoogleCloudConnectorsV1NodeConfig", + "description": "Optional. Configuration for the connection." + }, + "serviceAccount": { + "description": "Optional. Service account needed for runtime plane to access GCP resources.", + "type": "string" + }, + "serviceDirectory": { + "description": "Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. \"projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors\"", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "GoogleCloudConnectorsV1ConnectionStatus", + "description": "Output only. Current status of the connection.", + "readOnly": true + }, + "suspended": { + "description": "Optional. Suspended indicates if a user has suspended a connection or not.", + "type": "boolean" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1ConnectionStatus": { + "description": "ConnectionStatus indicates the state of the connection.", + "id": "GoogleCloudConnectorsV1ConnectionStatus", + "properties": { + "description": { + "description": "Description.", + "type": "string" + }, + "state": { + "description": "State.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "INACTIVE", + "DELETING", + "UPDATING", + "ERROR" + ], + "enumDescriptions": [ + "Connection does not have a state yet.", + "Connection is being created.", + "Connection is running and ready for requests.", + "Connection is stopped.", + "Connection is being deleted.", + "Connection is being updated.", + "Connection is not running due to an error." + ], + "type": "string" + }, + "status": { + "description": "Status provides detailed information for the state.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1Destination": { + "id": "GoogleCloudConnectorsV1Destination", + "properties": { + "host": { + "description": "For publicly routable host.", + "type": "string" + }, + "port": { + "description": "The port is the target port number that is accepted by the destination.", + "format": "int32", + "type": "integer" + }, + "serviceAttachment": { + "description": "PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1DestinationConfig": { + "description": "Define the Connectors target endpoint.", + "id": "GoogleCloudConnectorsV1DestinationConfig", + "properties": { + "destinations": { + "description": "The destinations for the key.", + "items": { + "$ref": "GoogleCloudConnectorsV1Destination" + }, + "type": "array" + }, + "key": { + "description": "The key is the destination identifier that is supported by the Connector.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1LockConfig": { + "description": "Determines whether or no a connection is locked. If locked, a reason must be specified.", + "id": "GoogleCloudConnectorsV1LockConfig", + "properties": { + "locked": { + "description": "Indicates whether or not the connection is locked.", + "type": "boolean" + }, + "reason": { + "description": "Describes why a connection is locked.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1NodeConfig": { + "description": "Configuration for the connection.", + "id": "GoogleCloudConnectorsV1NodeConfig", + "properties": { + "maxNodeCount": { + "description": "Maximum number of nodes in the runtime nodes.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Minimum number of nodes in the runtime nodes.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudConnectorsV1Secret": { + "description": "Secret provides a reference to entries in Secret Manager.", + "id": "GoogleCloudConnectorsV1Secret", + "properties": { + "secretVersion": { + "description": "The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaAccessToken": { + "description": "The access token represents the authorization of a specific application to access specific parts of a user\u2019s data.", + "id": "GoogleCloudIntegrationsV1alphaAccessToken", + "properties": { + "accessToken": { + "description": "The access token encapsulating the security identity of a process or thread.", + "type": "string" + }, + "accessTokenExpireTime": { + "description": "Required. The approximate time until the access token retrieved is valid.", + "format": "google-datetime", + "type": "string" + }, + "refreshToken": { + "description": "If the access token will expire, use the refresh token to obtain another access token.", + "type": "string" + }, + "refreshTokenExpireTime": { + "description": "The approximate time until the refresh token retrieved is valid.", + "format": "google-datetime", + "type": "string" + }, + "tokenType": { + "description": "Only support \"bearer\" token in v1 as bearer token is the predominant type used with OAuth 2.0.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaArchiveBundleRequest": { + "description": "Request for ArchiveBundle.", + "id": "GoogleCloudIntegrationsV1alphaArchiveBundleRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaArchiveBundleResponse": { + "description": "Response for ArchiveBundle.", + "id": "GoogleCloudIntegrationsV1alphaArchiveBundleResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest": { + "description": "Request for ArchiveIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse": { + "description": "Response for ArchiveIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaAttemptStats": { + "description": "Status for the execution attempt.", + "id": "GoogleCloudIntegrationsV1alphaAttemptStats", + "properties": { + "endTime": { + "description": "The end time of the event execution for current attempt.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "The start time of the event execution for current attempt. This could be in the future if it's been scheduled.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaAuthConfig": { + "description": "The AuthConfig resource use to hold channels and connection config data.", + "id": "GoogleCloudIntegrationsV1alphaAuthConfig", + "properties": { + "certificateId": { + "description": "Certificate id for client certificate", + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp when the auth config is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creatorEmail": { + "description": "The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "credentialType": { + "description": "Credential type of the encrypted credential.", + "enum": [ + "CREDENTIAL_TYPE_UNSPECIFIED", + "USERNAME_AND_PASSWORD", + "API_KEY", + "OAUTH2_AUTHORIZATION_CODE", + "OAUTH2_IMPLICIT", + "OAUTH2_CLIENT_CREDENTIALS", + "OAUTH2_RESOURCE_OWNER_CREDENTIALS", + "JWT", + "AUTH_TOKEN", + "SERVICE_ACCOUNT", + "CLIENT_CERTIFICATE_ONLY", + "OIDC_TOKEN" + ], + "enumDescriptions": [ + "Unspecified credential type", + "Regular username/password pair.", + "API key.", + "OAuth 2.0 Authorization Code Grant Type.", + "OAuth 2.0 Implicit Grant Type.", + "OAuth 2.0 Client Credentials Grant Type.", + "OAuth 2.0 Resource Owner Credentials Grant Type.", + "JWT Token.", + "Auth Token, e.g. bearer token.", + "Service Account which can be used to generate token for authentication.", + "Client Certificate only.", + "Google OIDC ID Token" + ], + "type": "string" + }, + "decryptedCredential": { + "$ref": "GoogleCloudIntegrationsV1alphaCredential", + "description": "Raw auth credentials." + }, + "description": { + "description": "A description of the auth config.", + "type": "string" + }, + "displayName": { + "description": "The name of the auth config.", + "type": "string" + }, + "encryptedCredential": { + "description": "Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.", + "format": "byte", + "type": "string" + }, + "expiryNotificationDuration": { + "description": "User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.", + "items": { + "format": "google-duration", + "type": "string" + }, + "type": "array" + }, + "lastModifierEmail": { + "description": "The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "name": { + "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.", + "type": "string" + }, + "overrideValidTime": { + "description": "User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.", + "format": "google-datetime", + "type": "string" + }, + "reason": { + "description": "The reason / details of the current status.", + "type": "string" + }, + "state": { + "description": "The status of the auth config.", + "enum": [ + "STATE_UNSPECIFIED", + "VALID", + "INVALID", + "SOFT_DELETED", + "EXPIRED", + "UNAUTHORIZED", + "UNSUPPORTED" + ], + "enumDescriptions": [ + "Status not specified.", + "Valid Auth config.", + "General invalidity, if it doesn't fits in the detailed issue below.", + "Auth config soft deleted.", + "Auth config expired.", + "Auth config unauthorized.", + "Auth config not supported." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the auth config is modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "validTime": { + "description": "The time until the auth config is valid. Empty or max value is considered the auth config won't expire.", + "format": "google-datetime", + "type": "string" + }, + "visibility": { + "description": "The visibility of the auth config.", + "enum": [ + "AUTH_CONFIG_VISIBILITY_UNSPECIFIED", + "PRIVATE", + "CLIENT_VISIBLE" + ], + "enumDescriptions": [ + "Visibility not specified.", + "Profile visible to the creator only.", + "Profile visible within the client." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaAuthToken": { + "description": "The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header.", + "id": "GoogleCloudIntegrationsV1alphaAuthToken", + "properties": { + "token": { + "description": "The token for the auth type.", + "type": "string" + }, + "type": { + "description": "Authentication type, e.g. \"Basic\", \"Bearer\", etc.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaBooleanParameterArray": { + "description": "This message only contains a field of boolean array.", + "id": "GoogleCloudIntegrationsV1alphaBooleanParameterArray", + "properties": { + "booleanValues": { + "description": "Boolean array.", + "items": { + "type": "boolean" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCancelExecutionRequest": { + "description": "Request for cancelling an execution.", + "id": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCancelExecutionResponse": { + "description": "Response for cancelling an execution.", + "id": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse", + "properties": { + "isCanceled": { + "description": "True if cancellation performed successfully", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCertificate": { + "description": "The certificate definition", + "id": "GoogleCloudIntegrationsV1alphaCertificate", + "properties": { + "certificateStatus": { + "description": "Status of the certificate", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "EXPIRED" + ], + "enumDescriptions": [ + "Unspecified certificate status", + "Certificate in active state will be able to use", + "Certificate in expired state needs to be updated" + ], + "type": "string" + }, + "credentialId": { + "description": "Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY", + "type": "string" + }, + "description": { + "description": "Description of the certificate", + "type": "string" + }, + "displayName": { + "description": "Name of the certificate", + "type": "string" + }, + "name": { + "description": "Output only. Auto generated primary key", + "readOnly": true, + "type": "string" + }, + "rawCertificate": { + "$ref": "GoogleCloudIntegrationsV1alphaClientCertificate", + "description": "Input only. Raw client certificate which would be registered with trawler" + }, + "requestorId": { + "description": "Immutable. Requestor ID to be used to register certificate with trawler", + "type": "string" + }, + "validEndTime": { + "description": "Output only. The timestamp after which certificate will expire", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "validStartTime": { + "description": "Output only. The timestamp after which certificate will be valid", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaClientCertificate": { + "description": "Contains client certificate information", + "id": "GoogleCloudIntegrationsV1alphaClientCertificate", + "properties": { + "encryptedPrivateKey": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "type": "string" + }, + "passphrase": { + "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", + "type": "string" + }, + "sslCertificate": { + "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata": { + "description": "Metadata of runtime connection schema.", + "id": "GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata", + "properties": { + "actions": { + "description": "List of actions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "entities": { + "description": "List of entity names.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest": { + "description": "Request for CreateAppsScriptProject rpc call.", + "id": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest", + "properties": { + "appsScriptProject": { + "description": "The name of the Apps Script project to be created.", + "type": "string" + }, + "authConfigId": { + "description": "The auth config id necessary to fetch the necessary credentials to create the project for external clients", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse": { + "description": "Response for CreateAppsScriptProject rpc call.", + "id": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse", + "properties": { + "projectId": { + "description": "The created AppsScriptProject ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCreateBundleRequest": { + "description": "PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request to create a new Bundle.", + "id": "GoogleCloudIntegrationsV1alphaCreateBundleRequest", + "properties": { + "bundleId": { + "description": "Required. name of the bundle that will be created", + "type": "string" + }, + "integrations": { + "description": "A list of integrations that can be executed by the bundle", + "items": { + "type": "string" + }, + "type": "array" + }, + "secondaryCustomerOrgId": { + "description": "Optional. The prefix for the SA, it should be in the format \"o\". This is an optional field, and if empty service account will be created per project, where we are creating bundle. This should only be used as the org ID for which we want to run the integrations in the bundle.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCreateBundleResponse": { + "description": "Response for create bundle.", + "id": "GoogleCloudIntegrationsV1alphaCreateBundleResponse", + "properties": { + "config": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", + "description": "It contains the bundle data" + }, + "triggerId": { + "description": "trigger_id of the bundle task", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCredential": { + "description": "Defines parameters for a single, canonical credential.", + "id": "GoogleCloudIntegrationsV1alphaCredential", + "properties": { + "authToken": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthToken", + "description": "Auth token credential" + }, + "credentialType": { + "description": "Credential type associated with auth config.", + "enum": [ + "CREDENTIAL_TYPE_UNSPECIFIED", + "USERNAME_AND_PASSWORD", + "API_KEY", + "OAUTH2_AUTHORIZATION_CODE", + "OAUTH2_IMPLICIT", + "OAUTH2_CLIENT_CREDENTIALS", + "OAUTH2_RESOURCE_OWNER_CREDENTIALS", + "JWT", + "AUTH_TOKEN", + "SERVICE_ACCOUNT", + "CLIENT_CERTIFICATE_ONLY", + "OIDC_TOKEN" + ], + "enumDescriptions": [ + "Unspecified credential type", + "Regular username/password pair.", + "API key.", + "OAuth 2.0 Authorization Code Grant Type.", + "OAuth 2.0 Implicit Grant Type.", + "OAuth 2.0 Client Credentials Grant Type.", + "OAuth 2.0 Resource Owner Credentials Grant Type.", + "JWT Token.", + "Auth Token, e.g. bearer token.", + "Service Account which can be used to generate token for authentication.", + "Client Certificate only.", + "Google OIDC ID Token" + ], + "type": "string" + }, + "jwt": { + "$ref": "GoogleCloudIntegrationsV1alphaJwt", + "description": "JWT credential" + }, + "oauth2AuthorizationCode": { + "$ref": "GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode", + "description": "The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential" + }, + "oauth2ClientCredentials": { + "$ref": "GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials", + "description": "OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials" + }, + "oauth2ResourceOwnerCredentials": { + "$ref": "GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials", + "description": "OAuth2 resource owner credentials" + }, + "oidcToken": { + "$ref": "GoogleCloudIntegrationsV1alphaOidcToken", + "description": "Google OIDC ID Token" + }, + "serviceAccountCredentials": { + "$ref": "GoogleCloudIntegrationsV1alphaServiceAccountCredentials", + "description": "Service account credential" + }, + "usernameAndPassword": { + "$ref": "GoogleCloudIntegrationsV1alphaUsernameAndPassword", + "description": "Username and password credential" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest": { + "description": "Request for DeactivateIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse": { + "description": "Response for DeactivateIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaDoubleParameterArray": { + "description": "This message only contains a field of double number array.", + "id": "GoogleCloudIntegrationsV1alphaDoubleParameterArray", + "properties": { + "doubleValues": { + "description": "Double number array.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse": { + "description": "Response for DownloadIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse", + "properties": { + "content": { + "description": "String representation of the integration version.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse": { + "description": "Response containing all provisioned regions for Connector Platform.", + "id": "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse", + "properties": { + "regions": { + "description": "All regions where Connector Platform is provisioned.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaEventParameter": { + "description": "This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.", + "id": "GoogleCloudIntegrationsV1alphaEventParameter", + "properties": { + "key": { + "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.", + "type": "string" + }, + "value": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType", + "description": "Values for the defined keys. Each value can either be string, int, double or any proto message." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest": { + "description": "The request for executing an integration.", + "id": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest", + "properties": { + "doNotPropagateError": { + "description": "Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.", + "type": "boolean" + }, + "executionId": { + "description": "Optional. The id of the ON_HOLD execution to be resumed.", + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Optional. Input parameters used by integration execution.", + "type": "object" + }, + "parameterEntries": { + "description": "Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" + }, + "type": "array" + }, + "parameters": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "description": "Optional. Passed in as parameters to each integration execution. Redacted" + }, + "requestId": { + "description": "Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.", + "type": "string" + }, + "triggerId": { + "description": "Optional. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse": { + "description": "The response for executing an integration.", + "id": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse", + "properties": { + "eventParameters": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", + "description": "Details for the integration that were executed." + }, + "executionFailed": { + "description": "Is true if any execution in the integration failed. False otherwise.", + "type": "boolean" + }, + "executionId": { + "description": "The id of the execution corresponding to this run of integration.", + "type": "string" + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.", + "type": "object" + }, + "parameterEntries": { + "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecution": { + "description": "The Execution resource contains detailed information of an individual integration execution.", + "id": "GoogleCloudIntegrationsV1alphaExecution", + "properties": { + "createTime": { + "description": "Output only. Created time of the execution.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "directSubExecutions": { + "description": "Direct sub executions of the following Execution.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaExecution" + }, + "type": "array" + }, + "eventExecutionDetails": { + "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetails", + "description": "The execution info about this event." + }, + "executionDetails": { + "$ref": "GoogleCloudIntegrationsV1alphaExecutionDetails", + "description": "Detailed info of this execution." + }, + "executionMethod": { + "description": "The ways user posts this event.", + "enum": [ + "EXECUTION_METHOD_UNSPECIFIED", + "POST", + "POST_TO_QUEUE", + "SCHEDULE" + ], + "enumDescriptions": [ + "Default value.", + "Sync post.", + "Async post.", + "Async post with schedule time." + ], + "type": "string" + }, + "name": { + "description": "Auto-generated primary key.", + "type": "string" + }, + "requestParameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Event parameters come in as part of the request.", + "type": "object" + }, + "requestParams": { + "description": "Event parameters come in as part of the request.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" + }, + "type": "array" + }, + "responseParameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Event parameters returned as part of the response.", + "type": "object" + }, + "responseParams": { + "description": "Event parameters come out as part of the response.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" + }, + "type": "array" + }, + "triggerId": { + "description": "The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Last modified time of the execution.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecutionDetails": { + "description": "Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics.", + "id": "GoogleCloudIntegrationsV1alphaExecutionDetails", + "properties": { + "attemptStats": { + "description": "List of Start and end time of the execution attempts.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaAttemptStats" + }, + "type": "array" + }, + "executionSnapshots": { + "description": "List of snapshots taken during the execution.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaExecutionSnapshot" + }, + "type": "array" + }, + "state": { + "description": "Status of the execution.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "PROCESSING", + "SUCCEEDED", + "FAILED", + "CANCELLED", + "RETRY_ON_HOLD", + "SUSPENDED" + ], + "enumDescriptions": [ + "Default.", + "Execution is scheduled and awaiting to be triggered.", + "Execution is processing.", + "Execution successfully finished. There's no more change after this state.", + "Execution failed. There's no more change after this state.", + "Execution canceled by user. There's no more change after this state.", + "Execution failed and waiting for retry.", + "Execution suspended and waiting for manual intervention." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecutionSnapshot": { + "description": "Contains the snapshot of the execution for a given checkpoint.", + "id": "GoogleCloudIntegrationsV1alphaExecutionSnapshot", + "properties": { + "checkpointTaskNumber": { + "description": "Indicates \"after which checkpoint task's execution\" this snapshot is taken.", + "type": "string" + }, + "executionSnapshotMetadata": { + "$ref": "GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata", + "description": "Metadata of the execution snapshot." + }, + "params": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Parameters used during the execution.", + "type": "object" + }, + "taskExecutionDetails": { + "description": "All of the task execution details at the given point of time.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaTaskExecutionDetails" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata": { + "description": "Metadata of the execution snapshot.", + "id": "GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata", + "properties": { + "executionAttempt": { + "description": "the execution attempt number this snapshot belongs to.", + "format": "int32", + "type": "integer" + }, + "task": { + "description": "the task name associated with this snapshot.", + "type": "string" + }, + "taskAttempt": { + "description": "the task attempt number this snapshot belongs to.", + "format": "int32", + "type": "integer" + }, + "taskNumber": { + "description": "The task number associated with this snapshot.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaFailurePolicy": { + "description": "Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).", + "id": "GoogleCloudIntegrationsV1alphaFailurePolicy", + "properties": { + "intervalTime": { + "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.", + "format": "google-datetime", + "type": "string" + }, + "maxRetries": { + "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.", + "format": "int32", + "type": "integer" + }, + "retryStrategy": { + "description": "Defines what happens to the task upon failure.", + "enum": [ + "RETRY_STRATEGY_UNSPECIFIED", + "IGNORE", + "NONE", + "FATAL", + "FIXED_INTERVAL", + "LINEAR_BACKOFF", + "EXPONENTIAL_BACKOFF", + "RESTART_INTEGRATION_WITH_BACKOFF" + ], + "enumDescriptions": [ + "UNSPECIFIED.", + "Ignores the failure of this task. The rest of the integration will be executed Assuming this task succeeded.", + "Causes a permanent failure of the task. However, if the last task(s) of event was successfully completed despite the failure of this task, it has no impact on the integration.", + "Causes a permanent failure of the event. It is different from NONE because this will mark the event as FAILED by shutting down the event execution.", + "The task will be retried from the failed task onwards after a fixed delay. A max-retry count is required to be specified with this strategy. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. max_retries and interval_in_seconds must be specified.", + "The task will be retried from the failed task onwards after a fixed delay that linearly increases with each retry attempt. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. max_retries and interval_in_seconds must be specified.", + "The task will be retried after an exponentially increasing period of time with each failure. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. `max_retries` and `interval_in_seconds` must be specified.", + "The entire integration will be restarted with the initial parameters that were set when the event was fired. A max-retry count is required to be specified with this strategy. `max_retries` and `interval_in_seconds` must be specified." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaGenerateTokenResponse": { + "description": "Returns success or error message", + "id": "GoogleCloudIntegrationsV1alphaGenerateTokenResponse", + "properties": { + "message": { + "description": "The message that notifies the user if the request succeeded or not.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaGetBundleResponse": { + "description": "Response for GetBundle.", + "id": "GoogleCloudIntegrationsV1alphaGetBundleResponse", + "properties": { + "config": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", + "description": "It contains the bundle data" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntParameterArray": { + "description": "This message only contains a field of integer array.", + "id": "GoogleCloudIntegrationsV1alphaIntParameterArray", + "properties": { + "intValues": { + "description": "Integer array.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntegration": { + "description": "The integration definition.", + "id": "GoogleCloudIntegrationsV1alphaIntegration", + "properties": { + "active": { + "description": "Required. If any integration version is published.", + "type": "boolean" + }, + "description": { + "description": "Optional.", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the integration.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Auto-generated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntegrationAlertConfig": { + "description": "Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.", + "id": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfig", + "properties": { + "aggregationPeriod": { + "description": "The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.", + "type": "string" + }, + "alertThreshold": { + "description": "For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.", + "format": "int32", + "type": "integer" + }, + "disableAlert": { + "description": "Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.", + "type": "boolean" + }, + "displayName": { + "description": "Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.", + "type": "string" + }, + "durationThreshold": { + "description": "Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.", + "format": "google-duration", + "type": "string" + }, + "metricType": { + "description": "The type of metric.", + "enum": [ + "METRIC_TYPE_UNSPECIFIED", + "EVENT_ERROR_RATE", + "EVENT_WARNING_RATE", + "TASK_ERROR_RATE", + "TASK_WARNING_RATE", + "TASK_RATE", + "EVENT_RATE", + "EVENT_AVERAGE_DURATION", + "EVENT_PERCENTILE_DURATION", + "TASK_AVERAGE_DURATION", + "TASK_PERCENTILE_DURATION" + ], + "enumDescriptions": [ + "The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.", + "Specifies alerting on the rate of errors for the enclosing integration.", + "Specifies alerting on the rate of warnings for the enclosing integration. Warnings use the same enum values as errors.", + "Specifies alerting on the rate of errors for any task in the enclosing integration.", + "Specifies alerting on the rate of warnings for any task in the enclosing integration.", + "Specifies alerting on the rate of executions over all tasks in the enclosing integration.", + "Specifies alerting on the number of events executed in the given aggregation_period.", + "Specifies alerting on the average duration of executions for this integration.", + "Specifies alerting on the duration value of a particular percentile of integration executions. E.g. If 10% or more of the integration executions have durations above 5 seconds, alert.", + "Specifies alerting on the average duration of any task in the enclosing integration,", + "Specifies alerting on the duration value of a particular percentile of any task executions within the enclosing integration. E.g. If 10% or more of the task executions in the integration have durations above 5 seconds, alert." + ], + "type": "string" + }, + "onlyFinalAttempt": { + "description": "For either events or tasks, depending on the type of alert, count only final attempts, not retries.", + "type": "boolean" + }, + "thresholdType": { + "description": "The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.", + "enum": [ + "THRESHOLD_TYPE_UNSPECIFIED", + "EXPECTED_MIN", + "EXPECTED_MAX" + ], + "enumDescriptions": [ + "Default.", + "Note that this field will only trigger alerts if the integration specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that `aggregation_period` for this alert configuration must be less than 24 hours. Min value threshold.", + "Max value threshold." + ], + "type": "string" + }, + "thresholdValue": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue", + "description": "The metric value, above or below which the alert should be triggered." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue": { + "description": "The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig.", + "id": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue", + "properties": { + "absolute": { + "description": "Absolute value threshold.", + "format": "int64", + "type": "string" + }, + "percentage": { + "description": "Percentage threshold.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig": { + "description": "This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time.", + "id": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", + "properties": { + "integrations": { + "description": "A bundle of integrations that can be executed by the task at runtime.", + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceAccount": { + "description": "Output only. The service account created and owned by IP and added to the customers GCP project.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntegrationParameter": { + "description": "Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.", + "id": "GoogleCloudIntegrationsV1alphaIntegrationParameter", + "properties": { + "dataType": { + "description": "Type of the parameter.", + "enum": [ + "INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "BOOLEAN_ARRAY", + "JSON_VALUE", + "PROTO_VALUE", + "PROTO_ARRAY" + ], + "enumDescriptions": [ + "Unspecified.", + "String.", + "Integer.", + "Double Number.", + "Boolean.", + "String Array.", + "Integer Array.", + "Double Number Array.", + "Boolean Array.", + "Json.", + "Proto Value (Internal use only).", + "Proto Array (Internal use only)." + ], + "type": "string" + }, + "defaultValue": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType", + "description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." + }, + "displayName": { + "description": "The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\".", + "type": "string" + }, + "inputOutputType": { + "description": "Specifies the input/output type for the parameter.", + "enum": [ + "IN_OUT_TYPE_UNSPECIFIED", + "IN", + "OUT", + "IN_OUT" + ], + "enumDescriptions": [ + "Default.", + "Input parameters for the integration. EventBus validates that these parameters exist in the integrations before execution.", + "Output Parameters for the integration. EventBus will only return the integration parameters tagged with OUT in the response back.", + "Input and Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response." + ], + "type": "string" + }, + "isTransient": { + "description": "Whether this parameter is a transient parameter.", + "type": "boolean" + }, + "jsonSchema": { + "description": "This schema will be used to validate runtime JSON-typed values of this parameter.", + "type": "string" + }, + "key": { + "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.", + "type": "string" + }, + "producer": { + "description": "The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.", + "type": "string" + }, + "searchable": { + "description": "Searchable in the execution log or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion": { + "description": "IntegrationTemplateVersion definition. An IntegrationTemplateVersion provides configurations required to construct an IntegrationVersion. It cannot be executed directly like an Integration. Users can create IntegrationTemplateVersions using Integrations. These Templates can be shared by users across GCP projects.", + "id": "GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion", + "properties": { + "createTime": { + "description": "Output only. Auto-generated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "databasePersistencePolicy": { + "description": "Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.", + "enum": [ + "DATABASE_PERSISTENCE_POLICY_UNSPECIFIED", + "DATABASE_PERSISTENCE_DISABLED" + ], + "enumDescriptions": [ + "Enables persistence for all execution data.", + "Disables persistence for all execution data." + ], + "type": "string" + }, + "description": { + "description": "Optional. The templateversion description. Permitted format is alphanumeric with underscores and no spaces.", + "type": "string" + }, + "lastModifierEmail": { + "description": "Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "name": { + "description": "Output only. Auto-generated primary key. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}", + "readOnly": true, + "type": "string" + }, + "parentIntegrationVersionId": { + "description": "Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion", + "type": "string" + }, + "snapshotNumber": { + "description": "Output only. An increasing sequence that is set when a new snapshot is created.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Optional. Generated by eventbus. User should not set it as an input.", + "enum": [ + "UNKNOWN", + "DRAFT", + "ACTIVE", + "ARCHIVED", + "SNAPSHOT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "taskConfigs": { + "description": "Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskConfig" + }, + "type": "array" + }, + "teardown": { + "$ref": "EnterpriseCrmEventbusProtoTeardown", + "description": "Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to \"finally\" in code." + }, + "templateParameters": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters", + "description": "Optional. Parameters that are expected to be passed to the IntegrationTemplateVersion when an event is triggered. This consists of all the parameters that are expected in the IntegrationTemplateVersion execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter." + }, + "triggerConfigs": { + "description": "Optional. Trigger configurations.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfig" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. Auto-generated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "userLabel": { + "description": "Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaIntegrationVersion": { + "description": "The integration version definition.", + "id": "GoogleCloudIntegrationsV1alphaIntegrationVersion", + "properties": { + "createTime": { + "description": "Output only. Auto-generated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "databasePersistencePolicy": { + "description": "Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.", + "enum": [ + "DATABASE_PERSISTENCE_POLICY_UNSPECIFIED", + "DATABASE_PERSISTENCE_DISABLED" + ], + "enumDescriptions": [ + "Enables persistence for all execution data.", + "Disables persistence for all execution data." + ], + "type": "string" + }, + "description": { + "description": "Optional. The integration description.", + "type": "string" + }, + "integrationParameters": { + "description": "Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationParameter" + }, + "type": "array" + }, + "integrationParametersInternal": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters", + "description": "Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter." + }, + "lastModifierEmail": { + "description": "Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "lockHolder": { + "description": "Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "name": { + "description": "Output only. Auto-generated primary key.", + "readOnly": true, + "type": "string" + }, + "origin": { + "description": "Optional. The origin that indicates where this integration is coming from.", + "enum": [ + "UNSPECIFIED", + "UI", + "PIPER_V2", + "PIPER_V3", + "APPLICATION_IP_PROVISIONING" + ], + "enumDescriptions": [ + "", + "Workflow is being created via event bus UI.", + "User checked in this workflow in Piper as v2 textproto format and we synced it into spanner.", + "User checked in this workflow in piper as v3 textproto format and we synced it into spanner.", + "Workflow is being created via Standalone IP Provisioning" + ], + "type": "string" + }, + "parentTemplateId": { + "description": "Optional. The id of the template which was used to create this integration_version.", + "type": "string" + }, + "snapshotNumber": { + "description": "Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use \"HEAD\" tag to identify the head.", + "format": "int64", + "type": "string" + }, + "state": { + "description": "Output only. User should not set it as an input.", + "enum": [ + "INTEGRATION_STATE_UNSPECIFIED", + "DRAFT", + "ACTIVE", + "ARCHIVED", + "SNAPSHOT" + ], + "enumDescriptions": [ + "Default.", + "Draft.", + "Active.", + "Archived.", + "Snapshot." + ], + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. Generated by eventbus. User should not set it as an input.", + "enum": [ + "UNKNOWN", + "DRAFT", + "ACTIVE", + "ARCHIVED", + "SNAPSHOT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "readOnly": true, + "type": "string" + }, + "taskConfigs": { + "description": "Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaTaskConfig" + }, + "type": "array" + }, + "taskConfigsInternal": { + "description": "Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskConfig" + }, + "type": "array" + }, + "teardown": { + "$ref": "EnterpriseCrmEventbusProtoTeardown", + "description": "Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to \"finally\" in code." + }, + "triggerConfigs": { + "description": "Optional. Trigger configurations.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaTriggerConfig" + }, + "type": "array" + }, + "triggerConfigsInternal": { + "description": "Optional. Trigger configurations.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfig" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. Auto-generated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "userLabel": { + "description": "Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaJwt": { + "description": "Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected.", + "id": "GoogleCloudIntegrationsV1alphaJwt", + "properties": { + "jwt": { + "description": "The token calculated by the header, payload and signature.", + "type": "string" + }, + "jwtHeader": { + "description": "Identifies which algorithm is used to generate the signature.", + "type": "string" + }, + "jwtPayload": { + "description": "Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.", + "type": "string" + }, + "secret": { + "description": "User's pre-shared secret to sign the token.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaLiftSuspensionRequest": { + "description": "Request for lift Suspension", + "id": "GoogleCloudIntegrationsV1alphaLiftSuspensionRequest", + "properties": { + "suspensionResult": { + "description": "User passed in suspension result and will be used to control workflow execution branching behavior by setting up corresponnding edge condition with suspension result. For example, if you want to lift the suspension, you can pass \"Approved\", or if you want to reject the suspension and terminate workfloe execution, you can pass \"Rejected\" and terminate the workflow execution with configuring the edge condition.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaLiftSuspensionResponse": { + "description": "Response of lift Suspense", + "id": "GoogleCloudIntegrationsV1alphaLiftSuspensionResponse", + "properties": { + "eventExecutionInfoId": { + "description": "Execution Id that will be returned", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest": { + "description": "Request for LinkAppsScriptProject rpc call.", + "id": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest", + "properties": { + "scriptId": { + "description": "The id of the Apps Script project to be linked.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse": { + "description": "Response for LinkAppsScriptProject rpc call.", + "id": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse", + "properties": { + "scriptId": { + "description": "The id of the linked Apps Script project.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse": { + "description": "Response to list AuthConfigs.", + "id": "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse", + "properties": { + "authConfigs": { + "description": "The list of AuthConfigs retrieved.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token used to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListCertificatesResponse": { + "description": "Response to list Certificates.", + "id": "GoogleCloudIntegrationsV1alphaListCertificatesResponse", + "properties": { + "certificates": { + "description": "The list of Certificates retrieved.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaCertificate" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token used to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListConnectionsResponse": { + "description": "Response containing Connections listed by region.", + "id": "GoogleCloudIntegrationsV1alphaListConnectionsResponse", + "properties": { + "connections": { + "description": "Connections.", + "items": { + "$ref": "GoogleCloudConnectorsV1Connection" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse": { + "description": "Response for listing the integration execution snapshot.", + "id": "GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse", + "properties": { + "executionSnapshots": { + "description": "Required. The detailed information for the execution snapshot.", + "items": { + "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshot" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token returned in the previous response.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListExecutionsResponse": { + "description": "Response for listing the integration execution data.", + "id": "GoogleCloudIntegrationsV1alphaListExecutionsResponse", + "properties": { + "executionInfos": { + "description": "Required. The detailed information of requested executions.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo" + }, + "type": "array" + }, + "executions": { + "description": "The detailed information of requested executions", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaExecution" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token used to retrieve the next page results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListIntegrationTemplateVersionsResponse": { + "description": "Response for IntegrationTemplateVersions.ListIntegrationTemplateVersions.", + "id": "GoogleCloudIntegrationsV1alphaListIntegrationTemplateVersionsResponse", + "properties": { + "integrationTemplateVersions": { + "description": "The IntegrationTemplateVersions which match the request.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse": { + "description": "Response for ListIntegrationVersions.", + "id": "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse", + "properties": { + "integrationVersions": { + "description": "The integrations which match the request.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" + }, + "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" + }, + "noPermission": { + "description": "Whether the user has no permission on the version or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListIntegrationsResponse": { + "description": "Response for ListIntegrations.", + "id": "GoogleCloudIntegrationsV1alphaListIntegrationsResponse", + "properties": { + "integrations": { + "description": "The integrations which match the request.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegration" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The next page token for the response.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse": { + "description": "Response for listing RuntimeActionSchemas for a specific Connection.", + "id": "GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse", + "properties": { + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "runtimeActionSchemas": { + "description": "Runtime action schemas.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaRuntimeActionSchema" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse": { + "description": "Response for listing RuntimeEntitySchemas for a specific Connection.", + "id": "GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse", + "properties": { + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "runtimeEntitySchemas": { + "description": "Runtime entity schemas.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaRuntimeEntitySchema" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse": { + "description": "Response to list SfdcChannels.", + "id": "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse", + "properties": { + "nextPageToken": { + "description": "The token used to retrieve the next page of results.", + "type": "string" + }, + "sfdcChannels": { + "description": "The list of SfdcChannels retrieved.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse": { + "description": "Response to list SfdcInstances.", + "id": "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse", + "properties": { + "nextPageToken": { + "description": "The token used to retrieve the next page of results.", + "type": "string" + }, + "sfdcInstances": { + "description": "The list of SfdcInstances retrieved.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListSuspensionsResponse": { + "description": "Response for Suspensions.ListSuspensions.", + "id": "GoogleCloudIntegrationsV1alphaListSuspensionsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results.", + "type": "string" + }, + "suspensions": { + "description": "The suspensions for the relevant execution which the caller has permissions to view and resolve.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaSuspension" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse": { + "description": "This is a UI only method and will be moved away. Response for ListTaskEntities.", + "id": "GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse", + "properties": { + "taskEntities": { + "description": "The list of the tasks.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskEntity" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest": { + "description": "The request to get data for monarch connector config.", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequest", + "properties": { + "duration": { + "description": "How long the series data range: \"1h\",\"1d\",etc.", + "format": "google-duration", + "type": "string" + }, + "endTime": { + "description": "Final time to query over, or the current time if left unset.", + "format": "google-datetime", + "type": "string" + }, + "mashQuery": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery", + "description": "Required. Query for searching data in monarch." + }, + "metricFieldTable": { + "description": "Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality.", + "type": "boolean" + }, + "outputPeriod": { + "description": "The output period for the query. Must be set if there is a window operation within the query and unset otherwise.", + "format": "google-duration", + "type": "string" + }, + "responseTemplate": { + "description": "Required. Template for response.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "TABLE_CONFIG", + "APLOSE_SERIES_LIST_CONFIG" + ], + "enumDescriptions": [ + "Unknown data format", + "Table data", + "Aplose series data" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy": { + "description": "MashQuery GroupBy parameters.", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy", + "properties": { + "fields": { + "description": "Optional. optional, metrics list for GroupBy.", + "items": { + "type": "string" + }, + "type": "array" + }, + "reducer": { + "description": "Optional. optional, reduce function for GroupBy.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery": { + "description": "The MashQuery for searching data, set both queries for Join Operation.", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQuery", + "properties": { + "firstQuery": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent", + "description": "Required. The components for constructing a mash query. Set \"point_operation\" if this is a single query" + }, + "operationMode": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode", + "description": "Optional. optional, only set when joining 2 queries. By default join 2 queries with join operation." + }, + "secondQuery": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent", + "description": "Optional. optional, only set when joining 2 queries. Set \"point_operation\" for joined query." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent": { + "description": "The components for constructing MashQuery.", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryComponent", + "properties": { + "borgTaskMetric": { + "description": "Required. The metric for monarch.BorgTask.", + "enum": [ + "BORG_TASK_METRIC_UNSPECIFIED", + "TASK_INDIVIDUAL_COUNT", + "EVENT_COUNT", + "EVENT_DURATION", + "TASK_INDIVIDUAL_DURATION" + ], + "enumDescriptions": [ + "Unknown metric", + "Metric end with: \"/task/individual_count\".", + "Metric end with: \"/event/count\".", + "Metric end with: \"/event/duration\".", + "Metric end with: \"/task/individual_duration\"." + ], + "type": "string" + }, + "dataFilters": { + "description": "Optional. optional, filters on fetched data, \"metric:client_id\" not supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fetchFilters": { + "description": "Optional. optional, filters for Fetch Raw, \"metric:client_id\" not supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "groupBy": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestGroupBy", + "description": "Optional. optional, GroupBy variables." + }, + "pointOperation": { + "description": "Optional. optional, Point Operation on single query or joined query.", + "type": "string" + }, + "timeDelta": { + "description": "Required. Window time delta.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode": { + "description": "Operation between 2 query", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationMode", + "properties": { + "joinConfig": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeJoinConfig", + "description": "Optional. join operation" + }, + "operationType": { + "description": "Optional. optional operation types.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "UNION", + "JOIN" + ], + "enumDescriptions": [ + "By default join.", + "Union operation", + "Join Operation" + ], + "type": "string" + }, + "unionConfig": { + "$ref": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeUnionConfig", + "description": "Optional. union operation" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeJoinConfig": { + "description": "Join Operation", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeJoinConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeUnionConfig": { + "description": "Union operation", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsRequestMashQueryOperationModeUnionConfig", + "properties": { + "reducer": { + "description": "Optional. optional, reduce function", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse": { + "description": "The response for getting Execution stats.", + "id": "GoogleCloudIntegrationsV1alphaMonitorExecutionStatsResponse", + "properties": { + "aplosSeriesListData": { + "$ref": "EnterpriseCrmCardsTemplatesAplosSeriesListData", + "description": "List of points." + }, + "tableData": { + "$ref": "EnterpriseCrmCardsTabularData", + "description": "Data in form of table." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaNextTask": { + "description": "The task that is next in line to be executed, if the condition specified evaluated to true.", + "id": "GoogleCloudIntegrationsV1alphaNextTask", + "properties": { + "condition": { + "description": "Standard filter expression for this task to become an eligible next task.", + "type": "string" + }, + "description": { + "description": "User-provided description intended to give additional business context about the task.", + "type": "string" + }, + "displayName": { + "description": "User-provided label that is attached to this edge in the UI.", + "type": "string" + }, + "taskConfigId": { + "description": "ID of the next task.", + "type": "string" + }, + "taskId": { + "description": "Task number of the next task.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode": { + "description": "The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens.", + "id": "GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode", + "properties": { + "accessToken": { + "$ref": "GoogleCloudIntegrationsV1alphaAccessToken", + "description": "The access token received from the token endpoint." + }, + "applyReauthPolicy": { + "description": "Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.", + "type": "boolean" + }, + "authCode": { + "description": "The Auth Code that is used to initially retrieve the access token.", + "type": "string" + }, + "authEndpoint": { + "description": "The auth url endpoint to send the auth code request to.", + "type": "string" + }, + "authParams": { + "$ref": "GoogleCloudIntegrationsV1alphaParameterMap", + "description": "The auth parameters sent along with the auth code request." + }, + "clientId": { + "description": "The client's id.", + "type": "string" + }, + "clientSecret": { + "description": "The client's secret.", + "type": "string" + }, + "requestType": { + "description": "Represent how to pass parameters to fetch access token", + "enum": [ + "REQUEST_TYPE_UNSPECIFIED", + "REQUEST_BODY", + "QUERY_PARAMETERS", + "ENCODED_HEADER" + ], + "enumDescriptions": [ + "Unspecified request type", + "To pass all the parameters in post body.", + "To pass all the parameters as a part of query parameter.", + "To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body." + ], + "type": "string" + }, + "scope": { + "description": "A space-delimited list of requested scope permissions.", + "type": "string" + }, + "tokenEndpoint": { + "description": "The token url endpoint to send the token request to.", + "type": "string" + }, + "tokenParams": { + "$ref": "GoogleCloudIntegrationsV1alphaParameterMap", + "description": "The token parameters sent along with the token request." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials": { + "description": "For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token.", + "id": "GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials", + "properties": { + "accessToken": { + "$ref": "GoogleCloudIntegrationsV1alphaAccessToken", + "description": "Access token fetched from the authorization server." + }, + "clientId": { + "description": "The client's ID.", + "type": "string" + }, + "clientSecret": { + "description": "The client's secret.", + "type": "string" + }, + "requestType": { + "description": "Represent how to pass parameters to fetch access token", + "enum": [ + "REQUEST_TYPE_UNSPECIFIED", + "REQUEST_BODY", + "QUERY_PARAMETERS", + "ENCODED_HEADER" + ], + "enumDescriptions": [ + "Unspecified request type", + "To pass all the parameters in post body.", + "To pass all the parameters as a part of query parameter.", + "To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body." + ], + "type": "string" + }, + "scope": { + "description": "A space-delimited list of requested scope permissions.", + "type": "string" + }, + "tokenEndpoint": { + "description": "The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.", + "type": "string" + }, + "tokenParams": { + "$ref": "GoogleCloudIntegrationsV1alphaParameterMap", + "description": "Token parameters for the auth request." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials": { + "description": "For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token.", + "id": "GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials", + "properties": { + "accessToken": { + "$ref": "GoogleCloudIntegrationsV1alphaAccessToken", + "description": "Access token fetched from the authorization server." + }, + "clientId": { + "description": "The client's ID.", + "type": "string" + }, + "clientSecret": { + "description": "The client's secret.", + "type": "string" + }, + "password": { + "description": "The user's password.", + "type": "string" + }, + "requestType": { + "description": "Represent how to pass parameters to fetch access token", + "enum": [ + "REQUEST_TYPE_UNSPECIFIED", + "REQUEST_BODY", + "QUERY_PARAMETERS", + "ENCODED_HEADER" + ], + "enumDescriptions": [ + "Unspecified request type", + "To pass all the parameters in post body.", + "To pass all the parameters as a part of query parameter.", + "To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body." + ], + "type": "string" + }, + "scope": { + "description": "A space-delimited list of requested scope permissions.", + "type": "string" + }, + "tokenEndpoint": { + "description": "The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.", + "type": "string" + }, + "tokenParams": { + "$ref": "GoogleCloudIntegrationsV1alphaParameterMap", + "description": "Token parameters for the auth request." + }, + "username": { + "description": "The user's username.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaOidcToken": { + "description": "OIDC Token", + "id": "GoogleCloudIntegrationsV1alphaOidcToken", + "properties": { + "audience": { + "description": "Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.", + "type": "string" + }, + "serviceAccountEmail": { + "description": "The service account email to be used as the identity for the token.", + "type": "string" + }, + "token": { + "description": "ID token obtained for the service account", + "type": "string" + }, + "tokenExpireTime": { + "description": "The approximate time until the token retrieved is valid.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaParameterMap": { + "description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.", + "id": "GoogleCloudIntegrationsV1alphaParameterMap", + "properties": { + "entries": { + "description": "A list of parameter map entries.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaParameterMapEntry" + }, + "type": "array" + }, + "keyType": { + "description": "Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.", + "enum": [ + "INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "BOOLEAN_ARRAY", + "JSON_VALUE", + "PROTO_VALUE", + "PROTO_ARRAY" + ], + "enumDescriptions": [ + "Unspecified.", + "String.", + "Integer.", + "Double Number.", + "Boolean.", + "String Array.", + "Integer Array.", + "Double Number Array.", + "Boolean Array.", + "Json.", + "Proto Value (Internal use only).", + "Proto Array (Internal use only)." + ], + "type": "string" + }, + "valueType": { + "description": "Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.", + "enum": [ + "INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED", + "STRING_VALUE", + "INT_VALUE", + "DOUBLE_VALUE", + "BOOLEAN_VALUE", + "STRING_ARRAY", + "INT_ARRAY", + "DOUBLE_ARRAY", + "BOOLEAN_ARRAY", + "JSON_VALUE", + "PROTO_VALUE", + "PROTO_ARRAY" + ], + "enumDescriptions": [ + "Unspecified.", + "String.", + "Integer.", + "Double Number.", + "Boolean.", + "String Array.", + "Integer Array.", + "Double Number Array.", + "Boolean Array.", + "Json.", + "Proto Value (Internal use only).", + "Proto Array (Internal use only)." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaParameterMapEntry": { + "description": "Entry is a pair of key and value.", + "id": "GoogleCloudIntegrationsV1alphaParameterMapEntry", + "properties": { + "key": { + "$ref": "GoogleCloudIntegrationsV1alphaParameterMapField", + "description": "Key of the map entry." + }, + "value": { + "$ref": "GoogleCloudIntegrationsV1alphaParameterMapField", + "description": "Value of the map entry." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaParameterMapField": { + "description": "Field represents either the key or value in an entry.", + "id": "GoogleCloudIntegrationsV1alphaParameterMapField", + "properties": { + "literalValue": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType", + "description": "Passing a literal value." + }, + "referenceKey": { + "description": "Referencing one of the Integration variables.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest": { + "description": "Request for PublishIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse": { + "description": "Response for PublishIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest": { + "description": "Request for [Suspensions.ResolveSuspensions].", + "id": "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest", + "properties": { + "suspension": { + "$ref": "GoogleCloudIntegrationsV1alphaSuspension", + "description": "Suspension, containing the event_execution_info_id, task_id, and state to set on the corresponding suspension record." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaResolveSuspensionResponse": { + "description": "Response for Suspensions.ResolveSuspensions.", + "id": "GoogleCloudIntegrationsV1alphaResolveSuspensionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaRuntimeActionSchema": { + "description": "Metadata of an action, including schemas for its inputs and outputs.", + "id": "GoogleCloudIntegrationsV1alphaRuntimeActionSchema", + "properties": { + "action": { + "description": "Name of the action.", + "type": "string" + }, + "inputSchema": { + "description": "Input parameter schema for the action.", + "type": "string" + }, + "outputSchema": { + "description": "Output parameter schema for the action.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaRuntimeEntitySchema": { + "description": "Metadata of an entity, including a schema for its properties.", + "id": "GoogleCloudIntegrationsV1alphaRuntimeEntitySchema", + "properties": { + "arrayFieldSchema": { + "description": "The above schema, but for an array of the associated entity.", + "type": "string" + }, + "entity": { + "description": "Name of the entity.", + "type": "string" + }, + "fieldSchema": { + "description": "List of fields in the entity.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest": { + "description": "The request for scheduling an integration.", + "id": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest", + "properties": { + "inputParameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Optional. Input parameters used by integration execution.", + "type": "object" + }, + "parameterEntries": { + "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", + "items": { + "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" + }, + "type": "array" + }, + "parameters": { + "$ref": "EnterpriseCrmEventbusProtoEventParameters", + "description": "Passed in as parameters to each integration execution." + }, + "requestId": { + "description": "This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.", + "type": "string" + }, + "scheduleTime": { + "description": "The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.", + "format": "google-datetime", + "type": "string" + }, + "triggerId": { + "description": "Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse": { + "description": "The response for executing an integration.", + "id": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse", + "properties": { + "executionInfoIds": { + "description": "The execution info id for the executed integrations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaServiceAccountCredentials": { + "description": "Represents the service account which can be used to generate access token for authenticating the service call.", + "id": "GoogleCloudIntegrationsV1alphaServiceAccountCredentials", + "properties": { + "scope": { + "description": "A space-delimited list of requested scope permissions.", + "type": "string" + }, + "serviceAccount": { + "description": "Name of the service account that has the permission to make the request.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaSfdcChannel": { + "description": "The SfdcChannel that points to a CDC or Platform Event Channel.", + "id": "GoogleCloudIntegrationsV1alphaSfdcChannel", + "properties": { + "channelTopic": { + "description": "The Channel topic defined by salesforce once an channel is opened", + "type": "string" + }, + "createTime": { + "description": "Output only. Time when the channel is created", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time when the channel was deleted. Empty if not deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description for this channel", + "type": "string" + }, + "displayName": { + "description": "Client level unique name/alias to easily reference a channel.", + "type": "string" + }, + "isActive": { + "description": "Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.", + "type": "boolean" + }, + "lastReplayId": { + "description": "Last sfdc messsage replay id for channel", + "type": "string" + }, + "name": { + "description": "Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when the channel was last updated", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaSfdcInstance": { + "description": "The SfdcInstance resource use to hold channels and connection config data.", + "id": "GoogleCloudIntegrationsV1alphaSfdcInstance", + "properties": { + "authConfigId": { + "description": "A list of AuthConfigs that can be tried to open the channel to SFDC", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Time when the instance is created", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time when the instance was deleted. Empty if not deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "A description of the sfdc instance.", + "type": "string" + }, + "displayName": { + "description": "User selected unique name/alias to easily reference an instance.", + "type": "string" + }, + "name": { + "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.", + "type": "string" + }, + "serviceAuthority": { + "description": "URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).", + "type": "string" + }, + "sfdcOrgId": { + "description": "The SFDC Org Id. This is defined in salesforce.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when the instance was last updated", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaStringParameterArray": { + "description": "This message only contains a field of string array.", + "id": "GoogleCloudIntegrationsV1alphaStringParameterArray", + "properties": { + "stringValues": { + "description": "String array.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaSuccessPolicy": { + "description": "Policy that dictates the behavior for the task after it completes successfully.", + "id": "GoogleCloudIntegrationsV1alphaSuccessPolicy", + "properties": { + "finalState": { + "description": "State to which the execution snapshot status will be set if the task succeeds.", + "enum": [ + "FINAL_STATE_UNSPECIFIED", + "SUCCEEDED", + "SUSPENDED" + ], + "enumDescriptions": [ + "UNSPECIFIED.", + "The default behavior, where successful tasks will be marked as SUCCEEDED.", + "Sets the state to SUSPENDED after executing. This is required for SuspensionTask; event execution will continue once the user calls ResolveSuspensions with the event_execution_info_id and the task number." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaSuspension": { + "description": "A record representing a suspension.", + "id": "GoogleCloudIntegrationsV1alphaSuspension", + "properties": { + "approvalConfig": { + "$ref": "GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig", + "description": "Controls the notifications and approval permissions for this suspension." + }, + "audit": { + "$ref": "GoogleCloudIntegrationsV1alphaSuspensionAudit", + "description": "Metadata pertaining to the resolution of this suspension." + }, + "createTime": { + "description": "Output only. Auto-generated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "eventExecutionInfoId": { + "description": "Required. ID of the associated execution.", + "type": "string" + }, + "integration": { + "description": "Required. The name of the originating integration.", + "type": "string" + }, + "lastModifyTime": { + "description": "Output only. Auto-generated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name for suspensions suspension/{suspension_id}", + "type": "string" + }, + "state": { + "description": "Required. State of this suspension, indicating what action a resolver has taken.", + "enum": [ + "RESOLUTION_STATE_UNSPECIFIED", + "PENDING", + "REJECTED", + "LIFTED" + ], + "enumDescriptions": [ + "Unset state.", + "The suspension has not yet been resolved.", + "The resolver has rejected the suspension.", + "The resolver has lifted the suspension." + ], + "type": "string" + }, + "suspensionConfig": { + "$ref": "EnterpriseCrmEventbusProtoSuspensionConfig", + "description": "Controls the notifications and resolver permissions for this suspension." + }, + "taskId": { + "description": "Required. Task id of the associated SuspensionTask.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig": { + "description": "Configurations for approving the Suspension.", + "id": "GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig", + "properties": { + "customMessage": { + "description": "Information to provide for recipients.", + "type": "string" + }, + "emailAddresses": { + "description": "Email addresses to send approval request to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "expiration": { + "$ref": "GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration", + "description": "Indicates the next steps when no external actions happen on the suspension." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration": { + "description": "Expiration configs for the approval request.", + "id": "GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration", + "properties": { + "expireTime": { + "description": "Output only. Time after which the suspension expires, if no action taken.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "liftWhenExpired": { + "description": "Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.", + "type": "boolean" + }, + "remindTime": { + "description": "Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaSuspensionAudit": { + "description": "Contains when and by whom the suspension was resolved.", + "id": "GoogleCloudIntegrationsV1alphaSuspensionAudit", + "properties": { + "resolveTime": { + "description": "Time at which this suspension was resolved.", + "format": "google-datetime", + "type": "string" + }, + "resolver": { + "description": "Email address of the person who resolved this suspension.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest": { + "description": "Request for TakeoverEditLock.", + "id": "GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse": { + "description": "Response for TakeoverEditLock.", + "id": "GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse", + "properties": { + "integrationVersion": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", + "description": "Version after the lock is acquired by the new user." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaTaskConfig": { + "description": "The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.", + "id": "GoogleCloudIntegrationsV1alphaTaskConfig", + "properties": { + "description": { + "description": "Optional. User-provided description intended to give additional business context about the task.", + "type": "string" + }, + "displayName": { + "description": "Optional. User-provided label that is attached to this TaskConfig in the UI.", + "type": "string" + }, + "failurePolicy": { + "$ref": "GoogleCloudIntegrationsV1alphaFailurePolicy", + "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.)." + }, + "jsonValidationOption": { + "description": "Optional. If set, overrides the option configured in the Task implementation class.", + "enum": [ + "JSON_VALIDATION_OPTION_UNSPECIFIED", + "SKIP", + "PRE_EXECUTION", + "POST_EXECUTION", + "PRE_POST_EXECUTION" + ], + "enumDescriptions": [ + "As per the default behavior, no validation will be run. Will not override any option set in a Task.", + "Do not run any validation against JSON schemas.", + "Validate all potential input JSON parameters against schemas specified in IntegrationParameter.", + "Validate all potential output JSON parameters against schemas specified in IntegrationParameter.", + "Perform both PRE_EXECUTION and POST_EXECUTION validations." + ], + "type": "string" + }, + "nextTasks": { + "description": "Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaNextTask" + }, + "type": "array" + }, + "nextTasksExecutionPolicy": { + "description": "Optional. The policy dictating the execution of the next set of tasks for the current task.", + "enum": [ + "NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED", + "RUN_ALL_MATCH", + "RUN_FIRST_MATCH" + ], + "enumDescriptions": [ + "Default.", + "Execute all the tasks that satisfy their associated condition.", + "Execute the first task that satisfies the associated condition." + ], + "type": "string" + }, + "parameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaEventParameter" + }, + "description": "Optional. The customized parameters the user can pass to this task.", + "type": "object" + }, + "successPolicy": { + "$ref": "GoogleCloudIntegrationsV1alphaSuccessPolicy", + "description": "Optional. Determines what action to take upon successful task completion." + }, + "synchronousCallFailurePolicy": { + "$ref": "GoogleCloudIntegrationsV1alphaFailurePolicy", + "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post)." + }, + "task": { + "description": "Optional. The name for the task.", + "type": "string" + }, + "taskExecutionStrategy": { + "description": "Optional. The policy dictating the execution strategy of this task.", + "enum": [ + "TASK_EXECUTION_STRATEGY_UNSPECIFIED", + "WHEN_ALL_SUCCEED", + "WHEN_ANY_SUCCEED", + "WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED" + ], + "enumDescriptions": [ + "Default. If the strategy is not set explicitly, it will default to `WHEN_ALL_SUCCEED`.", + "Wait until all of its previous tasks finished execution, then verify at least one of the edge conditions is met, and execute if possible. This should be considered as WHEN_ALL_TASKS_SUCCEED.", + "Start execution as long as any of its previous tasks finished execution and the corresponding edge condition is met (since we will execute if only that succeeding edge condition is met).", + "Wait until all of its previous tasks finished execution, then verify the all edge conditions are met and execute if possible." + ], + "type": "string" + }, + "taskId": { + "description": "Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).", + "type": "string" + }, + "taskTemplate": { + "description": "Optional. Used to define task-template name if task is of type task-template", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaTaskExecutionDetails": { + "description": "Contains the details of the execution of this task.", + "id": "GoogleCloudIntegrationsV1alphaTaskExecutionDetails", + "properties": { + "taskAttemptStats": { + "description": "Status for the current task execution attempt.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaAttemptStats" + }, + "type": "array" + }, + "taskExecutionState": { + "description": "The execution state of this task.", + "enum": [ + "TASK_EXECUTION_STATE_UNSPECIFIED", + "PENDING_EXECUTION", + "IN_PROCESS", + "SUCCEED", + "FAILED", + "FATAL", + "RETRY_ON_HOLD", + "SKIPPED", + "CANCELLED", + "PENDING_ROLLBACK", + "ROLLBACK_IN_PROCESS", + "ROLLEDBACK", + "SUSPENDED" + ], + "enumDescriptions": [ + "Default value.", + "Task is waiting for its precondition tasks to finish to start the execution.", + "Task is under processing.", + "Task execution successfully finished. There's no more change after this state.", + "Task execution failed. There's no more change after this state.", + "Task execution failed and cause the whole event execution to fail immediately. There's no more change after this state.", + "Task execution failed and waiting for retry.", + "Task execution skipped. This happens when its precondition wasn't met, or the event execution been canceled before reach to the task. There's no more changes after this state.", + "Task execution canceled when in progress. This happens when event execution been canceled or any other task fall in fatal state.", + "Task is waiting for its dependency tasks' rollback to finish to start its rollback.", + "Task is rolling back.", + "Task is rolled back. This is the state we will set regardless of rollback succeeding or failing.", + "Task is a SuspensionTask which has executed once, creating a pending suspension." + ], + "type": "string" + }, + "taskNumber": { + "description": "Pointer to the task config it used for execution.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaTriggerConfig": { + "description": "Configuration detail of a trigger.", + "id": "GoogleCloudIntegrationsV1alphaTriggerConfig", + "properties": { + "alertConfig": { + "description": "Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfig" + }, + "type": "array" + }, + "description": { + "description": "Optional. User-provided description intended to give additional business context about the task.", + "type": "string" + }, + "label": { + "description": "Optional. The user created label for a particular trigger.", + "type": "string" + }, + "nextTasksExecutionPolicy": { + "description": "Optional. Dictates how next tasks will be executed.", + "enum": [ + "NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED", + "RUN_ALL_MATCH", + "RUN_FIRST_MATCH" + ], + "enumDescriptions": [ + "Default.", + "Execute all the tasks that satisfy their associated condition.", + "Execute the first task that satisfies the associated condition." + ], + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. \"name\" is a property for API triggers and \"subscription\" is a property for Pub/sub triggers.", + "type": "object" + }, + "startTasks": { + "description": "Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaNextTask" + }, + "type": "array" + }, + "triggerId": { + "description": "Optional. The backend trigger ID.", + "type": "string" + }, + "triggerNumber": { + "description": "Required. A number to uniquely identify each trigger config within the integration on UI.", + "type": "string" + }, + "triggerType": { + "description": "Optional. Type of trigger", + "enum": [ + "TRIGGER_TYPE_UNSPECIFIED", + "CRON", + "API", + "SFDC_CHANNEL", + "CLOUD_PUBSUB_EXTERNAL", + "SFDC_CDC_CHANNEL" + ], + "enumDescriptions": [ + "Unknown.", + "Trigger by scheduled time.", + "Trigger by API call.", + "Trigger by Salesforce Channel.", + "Trigger by Pub/Sub external.", + "SFDC Channel Trigger for CDC." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUpdateBundleRequest": { + "description": "THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request message for Bundle update", + "id": "GoogleCloudIntegrationsV1alphaUpdateBundleRequest", + "properties": { + "config": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", + "description": "It contains the updated bundle data" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUpdateBundleResponse": { + "description": "Response message for Bundle update", + "id": "GoogleCloudIntegrationsV1alphaUpdateBundleResponse", + "properties": { + "config": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationBundleConfig", + "description": "Contains updated bundle config" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest": { + "description": "Request for UploadIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest", + "properties": { + "content": { + "description": "The textproto of the integration_version.", + "type": "string" + }, + "fileFormat": { + "description": "File format for upload request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse": { + "description": "Response for UploadIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse", + "properties": { + "integrationVersion": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", + "description": "The uploaded integration." + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUsernameAndPassword": { + "description": "Username and password pair.", + "id": "GoogleCloudIntegrationsV1alphaUsernameAndPassword", + "properties": { + "password": { + "description": "Password to be used", + "type": "string" + }, + "username": { + "description": "Username to be used", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest": { + "description": "Request for ValidateIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse": { + "description": "Response for ValidateIntegrationVersion.", + "id": "GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaValueType": { + "description": "The type of the parameter.", + "id": "GoogleCloudIntegrationsV1alphaValueType", + "properties": { + "booleanArray": { + "$ref": "GoogleCloudIntegrationsV1alphaBooleanParameterArray", + "description": "Boolean Array." + }, + "booleanValue": { + "description": "Boolean.", + "type": "boolean" + }, + "doubleArray": { + "$ref": "GoogleCloudIntegrationsV1alphaDoubleParameterArray", + "description": "Double Number Array." + }, + "doubleValue": { + "description": "Double Number.", + "format": "double", + "type": "number" + }, + "intArray": { + "$ref": "GoogleCloudIntegrationsV1alphaIntParameterArray", + "description": "Integer Array." + }, + "intValue": { + "description": "Integer.", + "format": "int64", + "type": "string" + }, + "jsonValue": { + "description": "Json.", + "type": "string" + }, + "stringArray": { + "$ref": "GoogleCloudIntegrationsV1alphaStringParameterArray", + "description": "String Array." + }, + "stringValue": { + "description": "String.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest": { + "description": "Use this request to post all workflows associated with a given trigger id. Next available id: 10", + "id": "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest", + "properties": { + "clientId": { + "description": "Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.", + "type": "string" + }, + "ignoreErrorIfNoActiveWorkflow": { + "description": "Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.", + "type": "boolean" + }, + "parameters": { + "$ref": "EnterpriseCrmEventbusProtoEventParameters", + "description": "Passed in as parameters to each workflow execution. Optional." + }, + "priority": { + "description": "The request priority this request should be processed at. For internal users:", + "enum": [ + "UNSPCIFIED", + "SHEDDABLE", + "SHEDDABLE_PLUS", + "CRITICAL", + "CRITICAL_PLUS" + ], + "enumDescriptions": [ + "Unspecified", + "Frequent partial and occasional full unavailability is expected and not pageable. * Requests to this band will be shed before all other requests. * This is the default for async calls sent from batch jobs.", + "Partial unavailability is expected and is not necessarily pageable. * Requests to this band will be shed before any critical traffic. * This is the default for async calls sent from production jobs.", + "Any outage is a pageable event. * During a production outage requests in this band will only be shed before CRITICAL_PLUS. * This is the default for sync calls sent from production jobs.", + "Any outage is a pageable event. * The guideline is for < 10% of requests to a service to be in this band. * During a production outage requests in this band will be prioritized above all others. * Opt-in to CRITICAL_PLUS when your workflow triggers by human." + ], + "type": "string" + }, + "requestId": { + "description": "Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.", + "type": "string" + }, + "scheduledTime": { + "description": "Optional. Time in milliseconds since epoch when the given event would be scheduled.", + "format": "int64", + "type": "string" + }, + "testMode": { + "description": "Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.", + "type": "boolean" + }, + "triggerId": { + "description": "Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.", + "type": "string" + }, + "workflowName": { + "description": "Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "Application Integration API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/jobs.v3.json b/googleapiclient/discovery_cache/documents/jobs.v3.json index e33de68cc24..35a53473875 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3.json @@ -651,7 +651,7 @@ } } }, - "revision": "20220831", + "revision": "20220919", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json index c5bd57a1b06..638c3b10313 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +++ b/googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json @@ -681,7 +681,7 @@ } } }, - "revision": "20220831", + "revision": "20220919", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/jobs.v4.json b/googleapiclient/discovery_cache/documents/jobs.v4.json index 1f074fc9996..bd19f185329 100644 --- a/googleapiclient/discovery_cache/documents/jobs.v4.json +++ b/googleapiclient/discovery_cache/documents/jobs.v4.json @@ -903,7 +903,7 @@ } } }, - "revision": "20220831", + "revision": "20220919", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { diff --git a/googleapiclient/discovery_cache/documents/keep.v1.json b/googleapiclient/discovery_cache/documents/keep.v1.json index 491f3ffd600..a4a6622a39d 100644 --- a/googleapiclient/discovery_cache/documents/keep.v1.json +++ b/googleapiclient/discovery_cache/documents/keep.v1.json @@ -314,7 +314,7 @@ } } }, - "revision": "20220904", + "revision": "20220913", "rootUrl": "https://keep.googleapis.com/", "schemas": { "Attachment": { diff --git a/googleapiclient/discovery_cache/documents/libraryagent.v1.json b/googleapiclient/discovery_cache/documents/libraryagent.v1.json index e9a6b7e203f..e2de046f5d4 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { diff --git a/googleapiclient/discovery_cache/documents/licensing.v1.json b/googleapiclient/discovery_cache/documents/licensing.v1.json index cb8287d3b1a..7c992ce95f7 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index 34662bbe992..9d8c88af1e1 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://localservices.googleapis.com/", "schemas": { "GoogleAdsHomeservicesLocalservicesV1AccountReport": { diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index afced37addb..7e170114e39 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -6007,7 +6007,7 @@ } } }, - "revision": "20220823", + "revision": "20220826", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryOptions": { diff --git a/googleapiclient/discovery_cache/documents/manufacturers.v1.json b/googleapiclient/discovery_cache/documents/manufacturers.v1.json index 2a5d6532282..80f37624fe3 100644 --- a/googleapiclient/discovery_cache/documents/manufacturers.v1.json +++ b/googleapiclient/discovery_cache/documents/manufacturers.v1.json @@ -15,6 +15,7 @@ "description": "Public API for managing Manufacturer Center related data.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/manufacturers/", + "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -287,7 +288,7 @@ } } }, - "revision": "20220817", + "revision": "20220913", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -357,7 +358,7 @@ }, "grocery": { "$ref": "Grocery", - "description": "Grocery Attributes. For more information, see go/mfc-nutrition-attributes." + "description": "Grocery Attributes. See more at https://support.google.com/manufacturers/answer/12098458#grocery." }, "gtin": { "description": "The Global Trade Item Number (GTIN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gtin.", @@ -391,7 +392,7 @@ }, "nutrition": { "$ref": "Nutrition", - "description": "Nutrition Attributes. For more information, see go/mfc-nutrition-attributes." + "description": "Nutrition Attributes. See more at https://support.google.com/manufacturers/answer/12098458#food-servings." }, "pattern": { "description": "The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern.", @@ -571,7 +572,7 @@ "type": "object" }, "FloatUnit": { - "description": "Combination of float amout and unit.", + "description": "Combination of float amount and unit.", "id": "FloatUnit", "properties": { "amount": { diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json index 6b58c9a5b25..c6ccc1851c6 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -556,7 +556,7 @@ } } }, - "revision": "20220825", + "revision": "20220906", "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 cbe4f37ab89..cb461cc2b8e 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json @@ -584,7 +584,7 @@ } } }, - "revision": "20220825", + "revision": "20220906", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index b59609d3363..97fc31a0d3d 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -1467,7 +1467,7 @@ } } }, - "revision": "20220905", + "revision": "20220908", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index 32dc41b0c47..1cad5c15382 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -1467,7 +1467,7 @@ } } }, - "revision": "20220905", + "revision": "20220908", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index afc82155d45..63031f91565 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -769,7 +769,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index d1b8faceea0..1a6b3048296 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2576,7 +2576,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index 7df5e80ac78..bd5d3d474c2 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json index 71a7ca67370..ecb95c2a003 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json @@ -198,7 +198,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinessbusinesscalls.googleapis.com/", "schemas": { "AggregateMetrics": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index f0430d4c491..0969cef902c 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -662,7 +662,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index 92cf5891446..89117aac2c7 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { @@ -4982,7 +4982,7 @@ "type": "array" }, "leedCertification": { - "description": "LEED certification.", + "description": "LEED certification. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC.", "enum": [ "LEED_CERTIFICATION_UNSPECIFIED", "NO_LEED_CERTIFICATION", @@ -5002,7 +5002,7 @@ "type": "string" }, "leedCertificationException": { - "description": "LEED certification exception.", + "description": "LEED certification exception. Deprecated: this field is no longer populated. LEED certification status is now provided directly by USGBC.", "enum": [ "EXCEPTION_UNSPECIFIED", "UNDER_CONSTRUCTION", diff --git a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json index 474933d3691..11db41ff911 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinessnotifications.googleapis.com/", "schemas": { "NotificationSetting": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index 4cf5a16f892..873a716882b 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json index 01dc343ae0c..a5fc052afff 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json @@ -323,7 +323,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinessqanda.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index fe1ddf35d5c..a5496b4aea7 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -256,7 +256,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index d6b4cd4f81c..48dcb50b276 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -938,7 +938,7 @@ } } }, - "revision": "20220817", + "revision": "20220912", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { @@ -998,7 +998,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 8a6ad2126cf..774295a658e 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20220812", + "revision": "20220908", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -709,7 +709,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, @@ -729,34 +729,34 @@ "type": "object" }, "CloudFunctionEndpoint": { - "description": "Wrapper for cloud function attributes.", + "description": "Wrapper for Cloud Function attributes.", "id": "CloudFunctionEndpoint", "properties": { "uri": { - "description": "A [Cloud function](https://cloud.google.com/functions) name.", + "description": "A [Cloud Function](https://cloud.google.com/functions) name.", "type": "string" } }, "type": "object" }, "CloudFunctionInfo": { - "description": "For display only. Metadata associated with a Cloud function.", + "description": "For display only. Metadata associated with a Cloud Function.", "id": "CloudFunctionInfo", "properties": { "displayName": { - "description": "Name of a Cloud function.", + "description": "Name of a Cloud Function.", "type": "string" }, "location": { - "description": "Location in which the Cloud function is deployed.", + "description": "Location in which the Cloud Function is deployed.", "type": "string" }, "uri": { - "description": "URI of a Cloud function.", + "description": "URI of a Cloud Function.", "type": "string" }, "versionId": { - "description": "Latest successfully deployed version id of the Cloud function.", + "description": "Latest successfully deployed version id of the Cloud Function.", "format": "int64", "type": "string" } @@ -873,7 +873,10 @@ "INTERNET", "GOOGLE_API", "GKE_MASTER", - "CLOUD_SQL_INSTANCE" + "CLOUD_SQL_INSTANCE", + "PSC_PUBLISHED_SERVICE", + "PSC_GOOGLE_API", + "PSC_VPC_SC" ], "enumDescriptions": [ "Target not specified.", @@ -881,7 +884,10 @@ "Target is the internet.", "Target is a Google API.", "Target is a Google Kubernetes Engine cluster master.", - "Target is a Cloud SQL instance." + "Target is a Cloud SQL instance.", + "Target is a published service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", + "Target is all Google APIs using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-apis).", + "Target is VPC-SC using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-apis)." ], "type": "string" } @@ -919,7 +925,8 @@ "CLOUD_SQL_INSTANCE_NO_IP_ADDRESS", "CLOUD_FUNCTION_NOT_ACTIVE", "VPC_CONNECTOR_NOT_SET", - "VPC_CONNECTOR_NOT_RUNNING" + "VPC_CONNECTOR_NOT_RUNNING", + "PSC_CONNECTION_NOT_ACCEPTED" ], "enumDescriptions": [ "Cause is unspecified.", @@ -944,9 +951,10 @@ "Packet was dropped inside Cloud SQL Service.", "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", "Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address.", - "Packet could be dropped because the Cloud function is not in an active status.", + "Packet could be dropped because the Cloud Function is not in an active status.", "Packet could be dropped because no VPC connector is set.", - "Packet could be dropped because the VPC connector is not in a running state." + "Packet could be dropped because the VPC connector is not in a running state.", + "Privte Service Connect (PSC) connection is not in accepted state." ], "type": "string" }, @@ -969,7 +977,7 @@ "properties": { "cloudFunction": { "$ref": "CloudFunctionEndpoint", - "description": "A [Cloud function](https://cloud.google.com/functions)." + "description": "A [Cloud Function](https://cloud.google.com/functions)." }, "cloudSqlInstance": { "description": "A [Cloud SQL](https://cloud.google.com/sql) instance URI.", @@ -1100,14 +1108,16 @@ "HIERARCHICAL_FIREWALL_POLICY_RULE", "VPC_FIREWALL_RULE", "IMPLIED_VPC_FIREWALL_RULE", - "SERVERLESS_VPC_ACCESS_MANAGED_FIREWALL_RULE" + "SERVERLESS_VPC_ACCESS_MANAGED_FIREWALL_RULE", + "NETWORK_FIREWALL_POLICY_RULE" ], "enumDescriptions": [ "Unspecified type.", "Hierarchical firewall policy rule. For details, see [Hierarchical firewall policies overview](https://cloud.google.com/vpc/docs/firewall-policies).", "VPC firewall rule. For details, see [VPC firewall rules overview](https://cloud.google.com/vpc/docs/firewalls).", "Implied VPC firewall rule. For details, see [Implied rules](https://cloud.google.com/vpc/docs/firewalls#default_firewall_rules).", - "Implicit firewall rules that are managed by serverless VPC access to allow ingress access. They are not visible in the Google Cloud console. For details, see [VPC connector's implicit rules](https://cloud.google.com/functions/docs/networking/connecting-vpc#restrict-access)." + "Implicit firewall rules that are managed by serverless VPC access to allow ingress access. They are not visible in the Google Cloud console. For details, see [VPC connector's implicit rules](https://cloud.google.com/functions/docs/networking/connecting-vpc#restrict-access).", + "Global network firewall policy rule. For details, see [Network firewall policies](https://cloud.google.com/vpc/docs/network-firewall-policies)." ], "type": "string" }, @@ -1391,12 +1401,14 @@ "enum": [ "BACKEND_TYPE_UNSPECIFIED", "BACKEND_SERVICE", - "TARGET_POOL" + "TARGET_POOL", + "TARGET_INSTANCE" ], "enumDescriptions": [ "Type is unspecified.", "Backend Service as the load balancer's backend.", - "Target Pool as the load balancer's backend." + "Target Pool as the load balancer's backend.", + "Target Instance as the load balancer's backend." ], "type": "string" }, @@ -1791,7 +1803,7 @@ }, "cloudFunction": { "$ref": "CloudFunctionInfo", - "description": "Display information of a Cloud function." + "description": "Display information of a Cloud Function." }, "cloudSqlInstance": { "$ref": "CloudSQLInstanceInfo", @@ -1885,7 +1897,7 @@ "Initial state: packet originating from a VPC or on-premises network with internal source IP. If the source is a VPC network visible to the user, a NetworkInfo is populated with details of the network.", "Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo is populated with starting instance information.", "Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information.", - "Initial state: packet originating from a Cloud function. A CloudFunctionInfo is populated with starting function information.", + "Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information.", "Config checking state: verify ingress firewall rule.", "Config checking state: verify egress firewall rule.", "Config checking state: verify route.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index a8fbc8631d8..7803fa8f421 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20220812", + "revision": "20220908", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -616,7 +616,8 @@ "MISMATCHED_SOURCE_NETWORK", "DESTINATION_ENDPOINT_NOT_FOUND", "MISMATCHED_DESTINATION_NETWORK", - "UNSUPPORTED" + "UNSUPPORTED", + "MISMATCHED_IP_VERSION" ], "enumDescriptions": [ "Cause is unspecified.", @@ -634,7 +635,8 @@ "Aborted because the source network does not match the source endpoint.", "Aborted because the destination endpoint could not be found.", "Aborted because the destination network does not match the destination endpoint.", - "Aborted because the test scenario is not supported." + "Aborted because the test scenario is not supported.", + "Aborted because the source and destination resources have no common IP version." ], "type": "string" }, @@ -709,7 +711,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, @@ -729,34 +731,34 @@ "type": "object" }, "CloudFunctionEndpoint": { - "description": "Wrapper for cloud function attributes.", + "description": "Wrapper for Cloud Function attributes.", "id": "CloudFunctionEndpoint", "properties": { "uri": { - "description": "A [Cloud function](https://cloud.google.com/functions) name.", + "description": "A [Cloud Function](https://cloud.google.com/functions) name.", "type": "string" } }, "type": "object" }, "CloudFunctionInfo": { - "description": "For display only. Metadata associated with a Cloud function.", + "description": "For display only. Metadata associated with a Cloud Function.", "id": "CloudFunctionInfo", "properties": { "displayName": { - "description": "Name of a Cloud function.", + "description": "Name of a Cloud Function.", "type": "string" }, "location": { - "description": "Location in which the Cloud function is deployed.", + "description": "Location in which the Cloud Function is deployed.", "type": "string" }, "uri": { - "description": "URI of a Cloud function.", + "description": "URI of a Cloud Function.", "type": "string" }, "versionId": { - "description": "Latest successfully deployed version id of the Cloud function.", + "description": "Latest successfully deployed version id of the Cloud Function.", "format": "int64", "type": "string" } @@ -921,6 +923,8 @@ "FORWARDING_RULE_NO_INSTANCES", "FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK", "INSTANCE_NOT_RUNNING", + "GKE_CLUSTER_NOT_RUNNING", + "CLOUD_SQL_INSTANCE_NOT_RUNNING", "TRAFFIC_TYPE_BLOCKED", "GKE_MASTER_UNAUTHORIZED_ACCESS", "CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS", @@ -928,13 +932,17 @@ "DROPPED_INSIDE_CLOUD_SQL_SERVICE", "GOOGLE_MANAGED_SERVICE_NO_PEERING", "CLOUD_SQL_INSTANCE_NO_IP_ADDRESS", + "GKE_CONTROL_PLANE_REGION_MISMATCH", + "PUBLIC_GKE_CONTROL_PLANE_TO_PRIVATE_DESTINATION", + "GKE_CONTROL_PLANE_NO_ROUTE", + "CLOUD_SQL_INSTANCE_NOT_CONFIGURED_FOR_EXTERNAL_TRAFFIC", + "PUBLIC_CLOUD_SQL_INSTANCE_TO_PRIVATE_DESTINATION", + "CLOUD_SQL_INSTANCE_NO_ROUTE", "CLOUD_FUNCTION_NOT_ACTIVE", "VPC_CONNECTOR_NOT_SET", "VPC_CONNECTOR_NOT_RUNNING", "FORWARDING_RULE_REGION_MISMATCH", - "PSC_CONNECTION_NOT_ACCEPTED", - "GKE_CLUSTER_NOT_RUNNING", - "CLOUD_SQL_INSTANCE_NOT_RUNNING" + "PSC_CONNECTION_NOT_ACCEPTED" ], "enumDescriptions": [ "Cause is unspecified.", @@ -952,6 +960,8 @@ "Forwarding rule does not have backends configured.", "Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. For more details, see [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules).", "Packet is sent from or to a Compute Engine instance that is not in a running state.", + "Packet sent from or to a GKE cluster that is not in running state.", + "Packet sent from or to a Cloud SQL instance that is not in running state.", "The type of traffic is blocked and the user cannot configure a firewall rule to enable it. See [Always blocked traffic](https://cloud.google.com/vpc/docs/firewalls#blockedtraffic) for more details.", "Access to Google Kubernetes Engine cluster master's endpoint is not authorized. See [Access to the cluster endpoints](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints) for more details.", "Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.", @@ -959,13 +969,17 @@ "Packet was dropped inside Cloud SQL Service.", "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", "Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address.", - "Packet could be dropped because the Cloud function is not in an active status.", + "Packet was dropped because a GKE cluster private endpoint is unreachable from a region different from the cluster's region.", + "Packet sent from a public GKE cluster control plane to a private IP address.", + "Packet was dropped because there is no route from a GKE cluster control plane to a destination network.", + "Packet sent from a Cloud SQL instance to an external IP address is not allowed. The Cloud SQL instance is not configured to send packets to external IP addresses.", + "Packet sent from a Cloud SQL instance with only a public IP address to a private IP address.", + "Packet was dropped because there is no route from a Cloud SQL instance to a destination network.", + "Packet could be dropped because the Cloud Function is not in an active status.", "Packet could be dropped because no VPC connector is set.", "Packet could be dropped because the VPC connector is not in a running state.", "Packet could be dropped because it was sent from a different region to a regional forwarding without global access.", - "Privte Service Connect (PSC) connection is not in accepted state.", - "Packet sent from or to a GKE cluster that is not in running state.", - "Packet sent from or to a Cloud SQL instance that is not in running state." + "Privte Service Connect (PSC) connection is not in accepted state." ], "type": "string" }, @@ -999,7 +1013,7 @@ "properties": { "cloudFunction": { "$ref": "CloudFunctionEndpoint", - "description": "A [Cloud function](https://cloud.google.com/functions)." + "description": "A [Cloud Function](https://cloud.google.com/functions)." }, "cloudSqlInstance": { "description": "A [Cloud SQL](https://cloud.google.com/sql) instance URI.", @@ -1143,7 +1157,7 @@ "VPC firewall rule. For details, see [VPC firewall rules overview](https://cloud.google.com/vpc/docs/firewalls).", "Implied VPC firewall rule. For details, see [Implied rules](https://cloud.google.com/vpc/docs/firewalls#default_firewall_rules).", "Implicit firewall rules that are managed by serverless VPC access to allow ingress access. They are not visible in the Google Cloud console. For details, see [VPC connector's implicit rules](https://cloud.google.com/functions/docs/networking/connecting-vpc#restrict-access).", - "Global network firewall policy rule." + "Global network firewall policy rule. For details, see [Network firewall policies](https://cloud.google.com/vpc/docs/network-firewall-policies)." ], "type": "string" }, @@ -1460,12 +1474,14 @@ "enum": [ "BACKEND_TYPE_UNSPECIFIED", "BACKEND_SERVICE", - "TARGET_POOL" + "TARGET_POOL", + "TARGET_INSTANCE" ], "enumDescriptions": [ "Type is unspecified.", "Backend Service as the load balancer's backend.", - "Target Pool as the load balancer's backend." + "Target Pool as the load balancer's backend.", + "Target Instance as the load balancer's backend." ], "type": "string" }, @@ -1930,7 +1946,7 @@ }, "cloudFunction": { "$ref": "CloudFunctionInfo", - "description": "Display information of a Cloud function." + "description": "Display information of a Cloud Function." }, "cloudSqlInstance": { "$ref": "CloudSQLInstanceInfo", @@ -2024,7 +2040,7 @@ "Initial state: packet originating from a VPC or on-premises network with internal source IP. If the source is a VPC network visible to the user, a NetworkInfo is populated with details of the network.", "Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo is populated with starting instance information.", "Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information.", - "Initial state: packet originating from a Cloud function. A CloudFunctionInfo is populated with starting function information.", + "Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information.", "Config checking state: verify ingress firewall rule.", "Config checking state: verify egress firewall rule.", "Config checking state: verify route.", diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index edf7ba020c0..f1fd15eb674 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -1037,7 +1037,7 @@ } } }, - "revision": "20220902", + "revision": "20220908", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AuthorizationPolicy": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index ca78b8846ca..a5c6121620d 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -1037,7 +1037,7 @@ } } }, - "revision": "20220902", + "revision": "20220908", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AuthorizationPolicy": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 71ac5903d26..90536b9be64 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -2148,7 +2148,7 @@ } } }, - "revision": "20220902", + "revision": "20220906", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 13912c902b3..4c2cfb6a7b4 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -1875,7 +1875,7 @@ } } }, - "revision": "20220902", + "revision": "20220906", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index f1399670ad3..51563dda0a7 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -1820,7 +1820,7 @@ } } }, - "revision": "20220830", + "revision": "20220909", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index 1f3fd499f03..f9db05f3a3e 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 96b99051e40..26d1be75236 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index c550b29f9c2..61d41190d4e 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -897,7 +897,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index 4c22c83c64b..daac05bf1b3 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -1000,7 +1000,7 @@ } } }, - "revision": "20220829", + "revision": "20220904", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index 70945dd9503..7793286dc7f 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -684,7 +684,7 @@ } } }, - "revision": "20220829", + "revision": "20220904", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index 18cd0304cc0..dc2c0777862 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -689,7 +689,7 @@ } } }, - "revision": "20220829", + "revision": "20220904", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { diff --git a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json index b7a166cc1b1..ee0b4ef27ec 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -193,7 +193,7 @@ } } }, - "revision": "20220909", + "revision": "20220916", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index fc652be3595..3b6bc4b2bc8 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -396,7 +396,7 @@ } } }, - "revision": "20220912", + "revision": "20220919", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -646,7 +646,7 @@ "id": "GoogleCloudPaymentsResellerSubscriptionV1Product", "properties": { "name": { - "description": "Output only. Response only. Resource name of the subscription. It will have the format of \"partners/{partner_id}/products/{product_id}\"", + "description": "Output only. Response only. Resource name of the product. It will have the format of \"partners/{partner_id}/products/{product_id}\"", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index befb6c9181c..5645fe687c9 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -1172,7 +1172,7 @@ } } }, - "revision": "20220908", + "revision": "20220915", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index f36cfdaf0f0..15e07d91352 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, - "revision": "20220910", + "revision": "20220915", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index 3e5c9139e8d..ccb91dc376c 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -718,7 +718,7 @@ } } }, - "revision": "20220910", + "revision": "20220915", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index 999310ad9eb..93eda8853de 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -347,7 +347,7 @@ } } }, - "revision": "20220910", + "revision": "20220915", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index 7fd7bfd4360..bdbe1b1d480 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -138,7 +138,7 @@ } } }, - "revision": "20220910", + "revision": "20220915", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountDetails": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json index ad2d59a9565..b5aced2b82e 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json index 5c6c540b2a3..a65b1472406 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1beta1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index 2e7840206e6..15aa71c6d81 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -493,7 +493,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1AccessStateDiff": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index af19c76d26c..2ccd636b556 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -172,7 +172,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1Replay": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json index 2674e9c70a0..4ec217b868c 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta1.json @@ -493,7 +493,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudPolicysimulatorV1Replay": { diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json index 23b003b09fd..ee63466f95a 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json @@ -1254,7 +1254,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json index a2324fcc01d..41723c31d1e 100644 --- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json @@ -2564,7 +2564,7 @@ } } }, - "revision": "20220904", + "revision": "20220916", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index 656acc86c49..d5ca8992b99 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -426,7 +426,7 @@ ], "parameters": { "name": { - "description": "Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`.", + "description": "Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format is `projects/{project}/snapshots/{snap}`.", "location": "path", "pattern": "^projects/[^/]+/snapshots/[^/]+$", "required": true, @@ -1424,7 +1424,7 @@ } } }, - "revision": "20220829", + "revision": "20220912", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1513,7 +1513,7 @@ "additionalProperties": { "type": "string" }, - "description": "See Creating and managing labels.", + "description": "See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).", "type": "object" }, "subscription": { @@ -1874,7 +1874,7 @@ "additionalProperties": { "type": "string" }, - "description": "Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: attributes { \"x-goog-version\": \"v1\" } ", + "description": "Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { \"x-goog-version\": \"v1\" }`", "type": "object" }, "oidcToken": { @@ -2063,7 +2063,7 @@ "id": "Subscription", "properties": { "ackDeadlineSeconds": { - "description": "The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be *outstanding*. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.", + "description": "The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.", "format": "int32", "type": "integer" }, @@ -2099,7 +2099,7 @@ "additionalProperties": { "type": "string" }, - "description": "See Creating and managing labels.", + "description": "See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).", "type": "object" }, "messageRetentionDuration": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json index 626e361ca81..0a9b45a7deb 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json @@ -457,7 +457,7 @@ } } }, - "revision": "20220829", + "revision": "20220912", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json index 2b109e7d9ae..267fa097d77 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json @@ -724,7 +724,7 @@ } } }, - "revision": "20220829", + "revision": "20220912", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsublite.v1.json b/googleapiclient/discovery_cache/documents/pubsublite.v1.json index 1692a4b1c3c..bc53e0d849c 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -1040,7 +1040,7 @@ } } }, - "revision": "20220902", + "revision": "20220913", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 9f5a46ccbaf..e04ff089cc1 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -178,7 +178,7 @@ "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", + "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", "format": "int32", "location": "query", "type": "integer" @@ -189,7 +189,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.", + "description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, for example, for all creatives pertaining to bidder (`123`), use `bidders/123`.", "location": "path", "pattern": "^bidders/[^/]+$", "required": true, @@ -827,7 +827,7 @@ "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available via another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive.", + "description": "Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available through another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive.", "format": "int32", "location": "query", "type": "integer" @@ -1023,7 +1023,7 @@ "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", + "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", "format": "int32", "location": "query", "type": "integer" @@ -1034,7 +1034,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.", + "description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, for example, for all creatives pertaining to bidder (`123`), use `bidders/123`.", "location": "path", "pattern": "^buyers/[^/]+$", "required": true, @@ -1305,7 +1305,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -1529,7 +1529,7 @@ "id": "Bidder", "properties": { "bypassNonguaranteedDealsPretargeting": { - "description": "Output only. A flag to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.", + "description": "Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.", "readOnly": true, "type": "boolean" }, @@ -1561,7 +1561,7 @@ "id": "Buyer", "properties": { "activeCreativeCount": { - "description": "Output only. The number of creatives that this buyer submitted via the API or bid with in the last 30 days. This is counted against the maximum number of active creatives.", + "description": "Output only. The number of creatives that this buyer submitted through the API or bid with in the last 30 days. This is counted against the maximum number of active creatives.", "format": "int64", "readOnly": true, "type": "string" @@ -1628,7 +1628,7 @@ "type": "string" }, "apiUpdateTime": { - "description": "Output only. The last update timestamp of the creative via API.", + "description": "Output only. The last update timestamp of the creative through the API.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2070,9 +2070,9 @@ ], "enumDescriptions": [ "Default value that should never be used.", - "Site's robots exclusion file (e.g., robots.txt) was unreachable.", - "Timed out reading site's robots exclusion file (e.g., robots.txt).", - "Crawler was disallowed by the site's robots exclusion file (e.g., robots.txt).", + "Site's robots exclusion file (for example, robots.txt) was unreachable.", + "Timed out reading site's robots exclusion file (for example, robots.txt).", + "Crawler was disallowed by the site's robots exclusion file (for example, robots.txt).", "Unknown reason." ], "type": "string" @@ -2103,7 +2103,7 @@ "type": "string" }, "httpError": { - "description": "HTTP error code (e.g. 404 or 5xx)", + "description": "HTTP error code (for example, 404 or 5xx)", "format": "int32", "type": "integer" }, @@ -2193,7 +2193,7 @@ "id": "DomainCallEvidence", "properties": { "topHttpCallDomains": { - "description": "Breakdown of the most frequent domains called via HTTP by the creative.", + "description": "Breakdown of the most frequent domains called through HTTP by the creative.", "items": { "$ref": "DomainCalls" }, @@ -2676,7 +2676,7 @@ "id": "PolicyCompliance", "properties": { "status": { - "description": "Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.", + "description": "Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.", "enum": [ "STATUS_UNSPECIFIED", "PENDING_REVIEW", @@ -2694,7 +2694,7 @@ "type": "string" }, "topics": { - "description": "Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.", + "description": "Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED.", "items": { "$ref": "PolicyTopicEntry" }, @@ -3293,7 +3293,7 @@ "id": "WatchCreativesResponse", "properties": { "subscription": { - "description": "The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Please use watchCreatives to re-enable the subscription.", + "description": "The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Use watchCreatives to re-enable the subscription.", "type": "string" }, "topic": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json index 9e5ad1935fe..16a1b95818d 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json @@ -234,7 +234,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivateBiddingFunctionRequest": { @@ -271,7 +271,7 @@ "enumDescriptions": [ "Default value that should not be used.", "An active function. Only `ACTIVE` bidding functions or ad scoring functions are made available for the server-side TURTLEDOVE simulations. Every account is limited to 10 active bidding functions per account.", - "A function that is no longer made available for invocation in a simulation and instead archived. An archived function can later be made active by activating the function via `ActivateBiddingFunction`." + "A function that is no longer made available for invocation in a simulation and instead archived. An archived function can later be made active by activating the function through `ActivateBiddingFunction`." ], "readOnly": true, "type": "string" @@ -286,7 +286,7 @@ "enumDescriptions": [ "Default value that should not be used.", "Bidding function that can be used by Authorized Buyers in the original TURTLEDOVE simulation. See documentation on the TURTLEDOVE simulation at https://developers.google.com/authorized-buyers/rtb/turtledove. The function takes in a Javascript object, `inputs`, that contains the following named fields: `openrtbContextualBidRequest` OR `googleContextualBidRequest`, `customContextualSignal`, `interestBasedBidData`, `interestGroupData`, and returns the bid price CPM. Example: ``` /* Returns a bid price CPM. * * @param {Object} inputs an object with the * following named fields: * - openrtbContextualBidRequest * OR googleContextualBidRequest * - customContextualSignal * - interestBasedBidData * - interestGroupData */ function biddingFunction(inputs) { ... return inputs.interestBasedBidData.cpm * inputs.customContextualSignals.placementMultiplier; } ```", - "Buyer's interest group bidding function that can be used by Authorized Buyers in the FLEDGE simulation. See the FLEDGE explainer at https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-device-bidding. The function takes one argument, `inputs`, that contains an object with the following named fields of the form: ``` { \"interestGroup\" : { \"ad\" : [ \"buyerCreativeId\": \"...\", # Ad creative ID \"adData\": { # JSON object } ], \"userBiddingSignals\": { . # JSON object } }, \"auctionSignals\": { \"url\": # string, \"slotVisibility\": # enum value, \"slotDimensions\": [ { \"height\": # number value \"width\": # number value } ] }, \"perBuyerSignals\": { # JSON object }, \"trustedBiddingSignals\": { # JSON object }, \"browserSignals\": { \"recent_impression_ages_secs\": [ # Array of integers. Not yet populated. ] } } ``` `interestGroup`: An object containing a list of `ad` objects, which contain the following named fields: - `buyerCreativeId`: The ad creative ID string. - `adData`: Any JSON value of the bidder's choosing to contain data associated with an ad provided in `BidResponse.ad.adslot.ad_data` for the Google Authorized Buyers protocol and `BidResponse.seatbid.bid.ext.ad_data` for the OpenRTB protocol. - `userBiddingSignals`: Any JSON value of the bidder's choosing containing interest group data that corresponds to user_bidding_signals (as in FLEDGE). This field will be populated from `BidResponse.interest_group_map.user_bidding_signals` for Google Authorized Buyers protocol and `BidResponse.ext.interest_group_map.user_bidding_signals` for the OpenRTB protocol. `auctionSignals`: Contains data from the seller. It corresponds to the auction signals data described in the FLEDGE proposal. It is an object containing the following named fields: - `url`: The string URL of the page with parameters removed. - `slotVisibility`: Enum of one of the following potential values: - NO_DETECTION = 0 - ABOVE_THE_FOLD = 1 - BELOW_THE_FOLD = 2 - `slotDimensions`: A list of objects containing containing width and height pairs in `width` and `height` fields, respectively, from `BidRequest.adslot.width` and `BidRequest.adslot.height` for the Google Authorized Buyers protocol and `BidRequest.imp.banner.format.w` and `BidRequest.imp.banner.format.h` for the OpenRTB protocol. `perBuyerSignals`: The contextual signals from the bid response that are populated in `BidResponse.interest_group_bidding.interest_group_buyers.per_buyer_signals` for the Google Authorized Buyers protocol and `BidResponse.ext.interest_group_bidding.interest_group_buyers.per_buyer_signals` for the OpenRTB protocol. These signals can be of any JSON format of your choosing, however, the buyer's domain name must match between: - the interest group response in `BidResponse.interest_group_map.buyer_domain` for the Google Authorized Buyers protocol or in `BidResponse.ext.interest_group_map.buyer_domain` for the OpenRTB protocol. - the contextual response as a key to the map in `BidResponse.interest_group_bidding.interest_group_buyers` for the Google Authorized Buyers protocol or in `BidResponse.ext.interest_group_bidding.interest_group_buyers` for the OpenRTB protocol. In other words, there must be a match between the buyer domain of the contextual per_buyer_signals and the domain of an interest group. `trustedBiddingSignals`: The trusted bidding signals that corresponds to the trusted_bidding_signals in the FLEDGE proposal. It is provided in the interest group response as `BidResponse.interest_group_map.user_bidding_signals` for the Google Authorized Buyers protocol and `BidResponse.ext.interest_group_map.user_bidding_signals` for the OpenRTB protocol. This field can be any JSON format of your choosing. `browserSignals`: An object of simulated browser-provider signals. It is an object with a single named field, `recent_impression_ages_secs`, that contains a list of estimated number value recent impression ages in seconds for a given interest group. `recent_impression_ages_secs` is not yet populated. The function returns the string creative ID of the selected ad, the bid price CPM, and (optionally) selected product IDs. In addition, the bidding function may populate an optional debug string that may be used for remote debugging and troubleshooting of a bidder-provided bidding function. The debug string should not contain a user identifier. The maximum length of the debug string is 200 bytes. This debug string is available in `BidResponseFeedback` (https://developers.google.com/authorized-buyers/rtb/realtime-bidding-guide#bidresponsefeedback-object) and `BidFeedback` (https://developers.google.com/authorized-buyers/rtb/openrtb-guide#bidfeedback), for the Google protocol and OpenRTB protocol respectively. In addition, the debug string can be inserted into the creative HTML snippet via macro substitution if the following string is included in the snippet: \u201c%%DEBUG_STRING%%\u201d. Please ensure the debug string complies with [Platform Program Policies](https://support.google.com/platformspolicy/answer/3013851). Sample Bidding Function: ``` function biddingFunction(inputs) { ... return { \"buyerCreativeId\": \"ad_creative_id_1\", \"bidPriceCpm\": 0.3, \"productIds\": [\"product_id_1\", \"product_id_2\", \"product_id_3\"] \"debugString\": \"Bidding function executed successfully!\" } } ```" + "Buyer's interest group bidding function that can be used by Authorized Buyers in the FLEDGE simulation. See the FLEDGE explainer at https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-device-bidding. The function takes one argument, `inputs`, that contains an object with the following named fields of the form: ``` { \"interestGroup\" : { \"ad\" : [ \"buyerCreativeId\": \"...\", # Ad creative ID \"adData\": { # JSON object } ], \"userBiddingSignals\": { . # JSON object } }, \"auctionSignals\": { \"url\": # string, \"slotVisibility\": # enum value, \"slotDimensions\": [ { \"height\": # number value \"width\": # number value } ] }, \"perBuyerSignals\": { # JSON object }, \"trustedBiddingSignals\": { # JSON object }, \"browserSignals\": { \"recent_impression_ages_secs\": [ # Array of integers. Not yet populated. ] } } ``` `interestGroup`: An object containing a list of `ad` objects, which contain the following named fields: - `buyerCreativeId`: The ad creative ID string. - `adData`: Any JSON value of the bidder's choosing to contain data associated with an ad provided in `BidResponse.ad.adslot.ad_data` for the Google Authorized Buyers protocol and `BidResponse.seatbid.bid.ext.ad_data` for the OpenRTB protocol. - `userBiddingSignals`: Any JSON value of the bidder's choosing containing interest group data that corresponds to user_bidding_signals (as in FLEDGE). This field will be populated from `BidResponse.interest_group_map.user_bidding_signals` for Google Authorized Buyers protocol and `BidResponse.ext.interest_group_map.user_bidding_signals` for the OpenRTB protocol. `auctionSignals`: Contains data from the seller. It corresponds to the auction signals data described in the FLEDGE proposal. It is an object containing the following named fields: - `url`: The string URL of the page with parameters removed. - `slotVisibility`: Enum of one of the following potential values: - NO_DETECTION = 0 - ABOVE_THE_FOLD = 1 - BELOW_THE_FOLD = 2 - `slotDimensions`: A list of objects containing containing width and height pairs in `width` and `height` fields, respectively, from `BidRequest.adslot.width` and `BidRequest.adslot.height` for the Google Authorized Buyers protocol and `BidRequest.imp.banner.format.w` and `BidRequest.imp.banner.format.h` for the OpenRTB protocol. `perBuyerSignals`: The contextual signals from the bid response that are populated in `BidResponse.interest_group_bidding.interest_group_buyers.per_buyer_signals` for the Google Authorized Buyers protocol and `BidResponse.ext.interest_group_bidding.interest_group_buyers.per_buyer_signals` for the OpenRTB protocol. These signals can be of any JSON format of your choosing, however, the buyer's domain name must match between: - the interest group response in `BidResponse.interest_group_map.buyer_domain` for the Google Authorized Buyers protocol or in `BidResponse.ext.interest_group_map.buyer_domain` for the OpenRTB protocol. - the contextual response as a key to the map in `BidResponse.interest_group_bidding.interest_group_buyers` for the Google Authorized Buyers protocol or in `BidResponse.ext.interest_group_bidding.interest_group_buyers` for the OpenRTB protocol. In other words, there must be a match between the buyer domain of the contextual per_buyer_signals and the domain of an interest group. `trustedBiddingSignals`: The trusted bidding signals that corresponds to the trusted_bidding_signals in the FLEDGE proposal. It is provided in the interest group response as `BidResponse.interest_group_map.user_bidding_signals` for the Google Authorized Buyers protocol and `BidResponse.ext.interest_group_map.user_bidding_signals` for the OpenRTB protocol. This field can be any JSON format of your choosing. `browserSignals`: An object of simulated browser-provider signals. It is an object with a single named field, `recent_impression_ages_secs`, that contains a list of estimated number value recent impression ages in seconds for a given interest group. `recent_impression_ages_secs` is not yet populated. The function returns the string creative ID of the selected ad, the bid price CPM, and (optionally) selected product IDs. In addition, the bidding function may populate an optional debug string that may be used for remote debugging and troubleshooting of a bidder-provided bidding function. The debug string should not contain a user identifier. The maximum length of the debug string is 200 bytes. This debug string is available in `BidResponseFeedback` (https://developers.google.com/authorized-buyers/rtb/realtime-bidding-guide#bidresponsefeedback-object) and `BidFeedback` (https://developers.google.com/authorized-buyers/rtb/openrtb-guide#bidfeedback), for the Google protocol and OpenRTB protocol respectively. In addition, the debug string can be inserted into the creative HTML snippet through macro substitution if the following string is included in the snippet: \u201c%%DEBUG_STRING%%\u201d. Ensure the debug string complies with [Platform Program Policies](https://support.google.com/platformspolicy/answer/3013851). Sample Bidding Function: ``` function biddingFunction(inputs) { ... return { \"buyerCreativeId\": \"ad_creative_id_1\", \"bidPriceCpm\": 0.3, \"productIds\": [\"product_id_1\", \"product_id_2\", \"product_id_3\"] \"debugString\": \"Bidding function executed successfully!\" } } ```" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 82f31f83a59..77fc707f091 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -514,7 +514,7 @@ } } }, - "revision": "20220826", + "revision": "20220910", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index 67ef6f88e63..3d699c82755 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -841,7 +841,7 @@ } } }, - "revision": "20220906", + "revision": "20220908", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index 8957d6e49d4..69d978e2e76 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -1442,7 +1442,7 @@ } } }, - "revision": "20220905", + "revision": "20220912", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json index afdf07fe168..bab352ebcf4 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -1442,7 +1442,7 @@ } } }, - "revision": "20220905", + "revision": "20220912", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1beta1CostProjection": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index d5737d9cd24..280273dc256 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -624,7 +624,7 @@ } } }, - "revision": "20220825", + "revision": "20220909", "rootUrl": "https://redis.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 6398f7803b4..42003724081 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -624,7 +624,7 @@ } } }, - "revision": "20220825", + "revision": "20220909", "rootUrl": "https://redis.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index 8d891a11eef..3f9170fabec 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -631,7 +631,7 @@ } } }, - "revision": "20220906", + "revision": "20220913", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json index f445071382e..049759b6187 100644 --- a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json +++ b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json @@ -499,7 +499,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://resourcesettings.googleapis.com/", "schemas": { "GoogleCloudResourcesettingsV1ListSettingsResponse": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 690c76ec0d6..17992d36a9d 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2289,7 +2289,7 @@ } } }, - "revision": "20220904", + "revision": "20220911", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -2569,7 +2569,7 @@ }, "livenessProbe": { "$ref": "Probe", - "description": "Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + "description": "Not supported by Cloud Run." }, "name": { "description": "Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names", diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 0d849ace13a..af1dc530c9d 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1064,7 +1064,7 @@ } } }, - "revision": "20220904", + "revision": "20220911", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json index 695d1390049..2ead8ac331e 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json @@ -210,7 +210,7 @@ } } }, - "revision": "20220829", + "revision": "20220915", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json index f30685836a6..a8c8b46cd3e 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json @@ -805,7 +805,7 @@ } } }, - "revision": "20220829", + "revision": "20220915", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json index 27149343c22..602a5054e9c 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, - "revision": "20220908", + "revision": "20220916", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleProtobufEmpty": { diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json index 69bfa7a64e6..7fb1a564f37 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -887,7 +887,7 @@ } } }, - "revision": "20220904", + "revision": "20220910", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index c091703f8d1..81427d4a658 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20220907", + "revision": "20220916", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index 2a573176177..f4e4de1bdbd 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -643,7 +643,7 @@ } } }, - "revision": "20220902", + "revision": "20220909", "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 19177af9736..b3cb03ba2ef 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -628,7 +628,7 @@ } } }, - "revision": "20220902", + "revision": "20220909", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 2c605345959..de16e3208d4 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -3058,7 +3058,7 @@ } } }, - "revision": "20220825", + "revision": "20220915", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -3782,7 +3782,7 @@ "additionalProperties": { "$ref": "ContactDetails" }, - "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", + "description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, @@ -3904,6 +3904,11 @@ "description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, + "parentDisplayName": { + "description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", + "readOnly": true, + "type": "string" + }, "processes": { "description": "Represents operating system processes associated with the Finding.", "items": { @@ -4225,6 +4230,42 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1ResourceValueConfig": { + "description": "A resource value config is a mapping configuration of user's tag values to resource values. Used by the attack path simulation.", + "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", + "properties": { + "name": { + "description": "Name for the resource value config", + "type": "string" + }, + "resourceValue": { + "description": "Required. Resource value level this expression represents", + "enum": [ + "RESOURCE_VALUE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "NONE" + ], + "enumDescriptions": [ + "Unspecific value", + "High resource value", + "Medium resource value", + "Low resource value", + "No resource value, e.g. ignore these resources" + ], + "type": "string" + }, + "tagValues": { + "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" E.g. [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": { "description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 6639e2d6c35..0a9fd8003f7 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,7 +896,7 @@ } } }, - "revision": "20220825", + "revision": "20220915", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1596,7 +1596,7 @@ "additionalProperties": { "$ref": "ContactDetails" }, - "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", + "description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, @@ -1718,6 +1718,11 @@ "description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, + "parentDisplayName": { + "description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", + "readOnly": true, + "type": "string" + }, "processes": { "description": "Represents operating system processes associated with the Finding.", "items": { @@ -2039,6 +2044,42 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1ResourceValueConfig": { + "description": "A resource value config is a mapping configuration of user's tag values to resource values. Used by the attack path simulation.", + "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", + "properties": { + "name": { + "description": "Name for the resource value config", + "type": "string" + }, + "resourceValue": { + "description": "Required. Resource value level this expression represents", + "enum": [ + "RESOURCE_VALUE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "NONE" + ], + "enumDescriptions": [ + "Unspecific value", + "High resource value", + "Medium resource value", + "Low resource value", + "No resource value, e.g. ignore these resources" + ], + "type": "string" + }, + "tagValues": { + "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" E.g. [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": { "description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 9e4b642c2ce..1c9ec2d1d6a 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -1981,7 +1981,7 @@ } } }, - "revision": "20220825", + "revision": "20220915", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2663,7 +2663,7 @@ "additionalProperties": { "$ref": "ContactDetails" }, - "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", + "description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, @@ -2785,6 +2785,11 @@ "description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, + "parentDisplayName": { + "description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", + "readOnly": true, + "type": "string" + }, "processes": { "description": "Represents operating system processes associated with the Finding.", "items": { @@ -3083,6 +3088,42 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1ResourceValueConfig": { + "description": "A resource value config is a mapping configuration of user's tag values to resource values. Used by the attack path simulation.", + "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", + "properties": { + "name": { + "description": "Name for the resource value config", + "type": "string" + }, + "resourceValue": { + "description": "Required. Resource value level this expression represents", + "enum": [ + "RESOURCE_VALUE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "NONE" + ], + "enumDescriptions": [ + "Unspecific value", + "High resource value", + "Medium resource value", + "Low resource value", + "No resource value, e.g. ignore these resources" + ], + "type": "string" + }, + "tagValues": { + "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" E.g. [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": { "description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse", diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 2c0a5bb968f..4d38ea7d97e 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20220907", + "revision": "20220916", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index d87606b0ce6..dc61b14c4b7 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -500,7 +500,7 @@ } } }, - "revision": "20220907", + "revision": "20220916", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index f12128cbfdb..3d0675e5cbe 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20220829", + "revision": "20220902", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index 998eb4b3c62..baaea35d615 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -169,7 +169,7 @@ } } }, - "revision": "20220829", + "revision": "20220902", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json index e1019d9a0c6..4e09d717527 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -883,7 +883,7 @@ } } }, - "revision": "20220831", + "revision": "20220907", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json index a14502a6452..45025c95efd 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -1059,7 +1059,7 @@ } } }, - "revision": "20220831", + "revision": "20220907", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 3579e62beb3..24ee5e2256e 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -829,7 +829,7 @@ } } }, - "revision": "20220902", + "revision": "20220913", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -2548,18 +2548,18 @@ "type": "object" }, "Quota": { - "description": "Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: \"1/min/{project}\" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: \"*\" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 ", + "description": "Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: \"1/min/{project}\" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: \"*\" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 ", "id": "Quota", "properties": { "limits": { - "description": "List of `QuotaLimit` definitions for the service.", + "description": "List of QuotaLimit definitions for the service.", "items": { "$ref": "QuotaLimit" }, "type": "array" }, "metricRules": { - "description": "List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.", + "description": "List of MetricRule definitions, each one mapping a selected method to one or more metrics.", "items": { "$ref": "MetricRule" }, diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index df7b09556d1..dbbb73cd422 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -865,7 +865,7 @@ } } }, - "revision": "20220906", + "revision": "20220916", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 76900639a7e..3fab65bc793 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20220906", + "revision": "20220916", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 555eb93283e..4f256058f48 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20220907", + "revision": "20220916", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 25e37d06237..94a3ecc9513 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -959,7 +959,7 @@ } } }, - "revision": "20220907", + "revision": "20220916", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 87f5d1c7ca8..106e04f286b 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20220831", + "revision": "20220909", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { diff --git a/googleapiclient/discovery_cache/documents/slides.v1.json b/googleapiclient/discovery_cache/documents/slides.v1.json index b9e2b0c57bb..c77c368f23b 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -313,7 +313,7 @@ } } }, - "revision": "20220830", + "revision": "20220915", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json index 6eeb627d64a..65f70a55cc5 100644 --- a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json @@ -355,7 +355,7 @@ } } }, - "revision": "20220904", + "revision": "20220914", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { diff --git a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json index 01ee75f3094..4d61168c614 100644 --- a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json +++ b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20220904", + "revision": "20220912", "rootUrl": "https://sourcerepo.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index c11a54aa8d4..c5d2104da8b 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -113,8 +113,119 @@ "resources": { "projects": { "resources": { + "instanceConfigOperations": { + "methods": { + "list": { + "description": "Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.", + "flatPath": "v1/projects/{projectsId}/instanceConfigOperations", + "httpMethod": "GET", + "id": "spanner.projects.instanceConfigOperations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same `parent` and with the same `filter`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project of the instance config operations. Values are of the form `projects/`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instanceConfigOperations", + "response": { + "$ref": "ListInstanceConfigOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + } + } + }, "instanceConfigs": { "methods": { + "create": { + "description": "Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", + "flatPath": "v1/projects/{projectsId}/instanceConfigs", + "httpMethod": "POST", + "id": "spanner.projects.instanceConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the project in which to create the instance config. Values are of the form `projects/`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instanceConfigs", + "request": { + "$ref": "CreateInstanceConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "delete": { + "description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", + "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", + "httpMethod": "DELETE", + "id": "spanner.projects.instanceConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the instance configuration to be deleted. Values are of the form `projects//instanceConfigs/`", + "location": "path", + "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "An option to validate, but not actually execute, a request, and provide the same response.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, "get": { "description": "Gets information about a particular instance configuration.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", @@ -177,6 +288,35 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/spanner.admin" ] + }, + "patch": { + "description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", + "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", + "httpMethod": "PATCH", + "id": "spanner.projects.instanceConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.", + "location": "path", + "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "UpdateInstanceConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] } }, "resources": { @@ -573,7 +713,7 @@ ], "parameters": { "filter": { - "description": "An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string \"prod\". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.name:howl) AND` \\ `(metadata.progress.start_time < \\\"2018-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string \"howl\". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test) AND` \\ `(metadata.progress.start_time < \\\"2022-01-18T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string \"test\". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.database:test_db)) OR` \\ `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test_bkp)) AND` \\ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string \"test_db\" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string \"test_bkp\" * The operation resulted in an error.", + "description": "An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string \"prod\". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.name:howl) AND` \\ `(metadata.progress.start_time < \\\"2018-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string \"howl\". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error.", "location": "query", "type": "string" }, @@ -2262,7 +2402,7 @@ } } }, - "revision": "20220902", + "revision": "20220914", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Backup": { @@ -2438,7 +2578,7 @@ "description": "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)." }, "members": { - "description": "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. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, @@ -2714,6 +2854,45 @@ }, "type": "object" }, + "CreateInstanceConfigMetadata": { + "description": "Metadata type for the operation returned by CreateInstanceConfig.", + "id": "CreateInstanceConfigMetadata", + "properties": { + "cancelTime": { + "description": "The time at which this operation was cancelled.", + "format": "google-datetime", + "type": "string" + }, + "instanceConfig": { + "$ref": "InstanceConfig", + "description": "The target instance config end state." + }, + "progress": { + "$ref": "OperationProgress", + "description": "The progress of the CreateInstanceConfig operation." + } + }, + "type": "object" + }, + "CreateInstanceConfigRequest": { + "description": "The request for CreateInstanceConfigRequest.", + "id": "CreateInstanceConfigRequest", + "properties": { + "instanceConfig": { + "$ref": "InstanceConfig", + "description": "Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." + }, + "instanceConfigId": { + "description": "Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations.", + "type": "string" + }, + "validateOnly": { + "description": "An option to validate, but not actually execute, a request, and provide the same response.", + "type": "boolean" + } + }, + "type": "object" + }, "CreateInstanceMetadata": { "description": "Metadata type for the operation returned by CreateInstance.", "id": "CreateInstanceMetadata", @@ -3321,10 +3500,33 @@ "description": "A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.", "id": "InstanceConfig", "properties": { + "baseConfig": { + "description": "Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.", + "type": "string" + }, + "configType": { + "description": "Output only. Whether this instance config is a Google or User Managed Configuration.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_MANAGED", + "USER_MANAGED" + ], + "enumDescriptions": [ + "Unspecified.", + "Google managed configuration.", + "User managed configuration." + ], + "readOnly": true, + "type": "string" + }, "displayName": { "description": "The name of this instance configuration as it appears in UIs.", "type": "string" }, + "etag": { + "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.", + "type": "string" + }, "freeInstanceAvailability": { "description": "Output only. Describes whether free instances are available to be created in this instance config.", "enum": [ @@ -3344,6 +3546,13 @@ "readOnly": true, "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + \"_\" + value would prove problematic if we were to allow \"_\" in a future release.", + "type": "object" + }, "leaderOptions": { "description": "Allowed values of the \"default_leader\" schema option for databases in instances that use this instance configuration.", "items": { @@ -3355,12 +3564,40 @@ "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.", "type": "string" }, + "optionalReplicas": { + "description": "Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.", + "items": { + "$ref": "ReplicaInfo" + }, + "readOnly": true, + "type": "array" + }, + "reconciling": { + "description": "Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.", + "readOnly": true, + "type": "boolean" + }, "replicas": { "description": "The geographic placement of nodes in this instance configuration and their replication properties.", "items": { "$ref": "ReplicaInfo" }, "type": "array" + }, + "state": { + "description": "Output only. The current instance config state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "READY" + ], + "enumDescriptions": [ + "Not specified.", + "The instance config is still being created.", + "The instance config is fully created and ready to be used to create instances." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3588,6 +3825,24 @@ }, "type": "object" }, + "ListInstanceConfigOperationsResponse": { + "description": "The response for ListInstanceConfigOperations.", + "id": "ListInstanceConfigOperationsResponse", + "properties": { + "nextPageToken": { + "description": "`next_page_token` can be sent in a subsequent ListInstanceConfigOperations call to fetch more of the matching metadata.", + "type": "string" + }, + "operations": { + "description": "The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, "ListInstanceConfigsResponse": { "description": "The response for ListInstanceConfigs.", "id": "ListInstanceConfigsResponse", @@ -4286,7 +4541,22 @@ "ReadWrite": { "description": "Message type to initiate a read-write transaction. Currently this transaction type has no options.", "id": "ReadWrite", - "properties": {}, + "properties": { + "readLockMode": { + "description": "Read lock mode for the transaction.", + "enum": [ + "READ_LOCK_MODE_UNSPECIFIED", + "PESSIMISTIC", + "OPTIMISTIC" + ], + "enumDescriptions": [ + "Default value. If the value is not specified, the pessimistic read lock is used.", + "Pessimistic lock mode. Read locks are acquired immediately on read.", + "Optimistic lock mode. Locks for reads within the transaction are not acquired on read. Instead the locks are acquired on a commit to validate that read/queried data has not changed since the transaction started." + ], + "type": "string" + } + }, "type": "object" }, "ReplicaInfo": { @@ -4859,11 +5129,13 @@ "description": "The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.", "enum": [ "TYPE_ANNOTATION_CODE_UNSPECIFIED", - "PG_NUMERIC" + "PG_NUMERIC", + "PG_JSONB" ], "enumDescriptions": [ "Not specified.", - "PostgreSQL compatible NUMERIC type. This annotation needs to be applied to Type instances having NUMERIC type code to specify that values of this type should be treated as PostgreSQL NUMERIC values. Currently this annotation is always needed for NUMERIC when a client interacts with PostgreSQL-enabled Spanner databases." + "PostgreSQL compatible NUMERIC type. This annotation needs to be applied to Type instances having NUMERIC type code to specify that values of this type should be treated as PostgreSQL NUMERIC values. Currently this annotation is always needed for NUMERIC when a client interacts with PostgreSQL-enabled Spanner databases.", + "PostgreSQL compatible JSONB type. This annotation needs to be applied to Type instances having JSON type code to specify that values of this type should be treated as PostgreSQL JSONB values. Currently this annotation is always needed for JSON when a client interacts with PostgreSQL-enabled Spanner databases." ], "type": "string" } @@ -4926,6 +5198,46 @@ }, "type": "object" }, + "UpdateInstanceConfigMetadata": { + "description": "Metadata type for the operation returned by UpdateInstanceConfig.", + "id": "UpdateInstanceConfigMetadata", + "properties": { + "cancelTime": { + "description": "The time at which this operation was cancelled.", + "format": "google-datetime", + "type": "string" + }, + "instanceConfig": { + "$ref": "InstanceConfig", + "description": "The desired instance config after updating." + }, + "progress": { + "$ref": "OperationProgress", + "description": "The progress of the UpdateInstanceConfig operation." + } + }, + "type": "object" + }, + "UpdateInstanceConfigRequest": { + "description": "The request for UpdateInstanceConfigRequest.", + "id": "UpdateInstanceConfigRequest", + "properties": { + "instanceConfig": { + "$ref": "InstanceConfig", + "description": "Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." + }, + "updateMask": { + "description": "Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.", + "format": "google-fieldmask", + "type": "string" + }, + "validateOnly": { + "description": "An option to validate, but not actually execute, a request, and provide the same response.", + "type": "boolean" + } + }, + "type": "object" + }, "UpdateInstanceMetadata": { "description": "Metadata type for the operation returned by UpdateInstance.", "id": "UpdateInstanceMetadata", diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index d912752635e..3f2d5df5e1d 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index b4c0e4a3e11..5d954fba0af 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index d447e8d3b22..c7bfd8d8ff3 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -26,7 +26,7 @@ "description": "Stores and retrieves potentially large, immutable data objects.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/storage/docs/json_api/", - "etag": "\"3136353533323635303738353835383235303236\"", + "etag": "\"3137343834393930383330303039303536333930\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -3005,7 +3005,7 @@ } } }, - "revision": "20220908", + "revision": "20220916", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { diff --git a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json index e302ff6234a..f8f2c5e307b 100644 --- a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json @@ -632,7 +632,7 @@ } } }, - "revision": "20220901", + "revision": "20220908", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index 7499051fa3a..57eea00e3ff 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -533,7 +533,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index ccd049f8a4b..00a9f970f09 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -131,7 +131,7 @@ } } }, - "revision": "20220902", + "revision": "20220910", "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 ce81cbf2b20..1ce29fe75ae 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -116,7 +116,7 @@ } } }, - "revision": "20220902", + "revision": "20220910", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index 8d424313196..fbe3a74f36d 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20220907", + "revision": "20220914", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index 574a79d05ec..6f6ac888eed 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3317,7 +3317,7 @@ } } }, - "revision": "20220907", + "revision": "20220914", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tasks.v1.json b/googleapiclient/discovery_cache/documents/tasks.v1.json index 9af01721f4c..d4cca6dce14 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20220910", + "revision": "20220916", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "Task": { diff --git a/googleapiclient/discovery_cache/documents/testing.v1.json b/googleapiclient/discovery_cache/documents/testing.v1.json index ac5dc428b8a..a5a13cd12e7 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -282,7 +282,7 @@ } } }, - "revision": "20220904", + "revision": "20220912", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index 018efc2fb4a..affe8f57a6c 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20220906", + "revision": "20220908", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index 3640939ee97..e44c69cc06f 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20220906", + "revision": "20220908", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index b316974254b..fb8bc6ca2a0 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, - "revision": "20220910", + "revision": "20220919", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json index a9d918c14a8..abae74155b0 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220829", + "revision": "20220908", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/transcoder.v1.json b/googleapiclient/discovery_cache/documents/transcoder.v1.json index f36ca2759f5..7a0d90699cc 100644 --- a/googleapiclient/discovery_cache/documents/transcoder.v1.json +++ b/googleapiclient/discovery_cache/documents/transcoder.v1.json @@ -385,7 +385,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index c94c00a7728..07502293169 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1193,7 +1193,7 @@ } } }, - "revision": "20220831", + "revision": "20220907", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/googleapiclient/discovery_cache/documents/versionhistory.v1.json b/googleapiclient/discovery_cache/documents/versionhistory.v1.json index a9d1de2a7bd..ad0fa44c65a 100644 --- a/googleapiclient/discovery_cache/documents/versionhistory.v1.json +++ b/googleapiclient/discovery_cache/documents/versionhistory.v1.json @@ -271,7 +271,7 @@ } } }, - "revision": "20220912", + "revision": "20220919", "rootUrl": "https://versionhistory.googleapis.com/", "schemas": { "Channel": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1.json index f5689ec511d..9300b19b86a 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1.json @@ -350,7 +350,7 @@ } } }, - "revision": "20220303", + "revision": "20220913", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -4972,7 +4972,7 @@ "type": "object" }, "GoogleProtobuf_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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "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": "GoogleProtobuf_Empty", "properties": {}, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json index f871ccd5ddc..e325c8e4c0a 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220303", + "revision": "20220913", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json index 81591f106fa..f9ff133a46c 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220303", + "revision": "20220913", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json index f0b32d7098b..3990e5d7a25 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220303", + "revision": "20220913", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json index a91a61dec37..1574af5c888 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220303", + "revision": "20220913", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 58cd62543c7..bed51e76b4f 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -1532,6 +1532,81 @@ ] } } + }, + "replicationCycles": { + "methods": { + "get": { + "description": "Gets details of a single ReplicationCycle.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles/{replicationCyclesId}", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.migratingVms.replicationCycles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReplicationCycle.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+/replicationCycles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ReplicationCycle" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ReplicationCycles in a given MigratingVM.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.migratingVms.replicationCycles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. the order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of replication cycles to return. The service may return fewer than this value. If unspecified, at most 100 migrating VMs will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Required. A page token, received from a previous `ListReplicationCycles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReplicationCycles` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of ReplicationCycles.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/replicationCycles", + "response": { + "$ref": "ListReplicationCyclesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -1897,7 +1972,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AddGroupMigrationRequest": { @@ -1954,7 +2029,7 @@ "Unspecified license for the OS.", "No license available for the OS.", "The license type is Pay As You Go license type.", - "The license type is is Bring Your Own License type." + "The license type is Bring Your Own License type." ], "type": "string" } @@ -2784,6 +2859,34 @@ }, "type": "object" }, + "ListReplicationCyclesResponse": { + "description": "Response message for 'ListReplicationCycles' request.", + "id": "ListReplicationCyclesResponse", + "properties": { + "nextPageToken": { + "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "readOnly": true, + "type": "string" + }, + "replicationCycles": { + "description": "Output only. The list of replication cycles response.", + "items": { + "$ref": "ReplicationCycle" + }, + "readOnly": true, + "type": "array" + }, + "unreachable": { + "description": "Output only. Locations that could not be reached.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "ListSourcesResponse": { "description": "Response message for 'ListSources' request.", "id": "ListSourcesResponse", diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index e9547ae1ee2..9219c4b30a5 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -1532,6 +1532,81 @@ ] } } + }, + "replicationCycles": { + "methods": { + "get": { + "description": "Gets details of a single ReplicationCycle.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles/{replicationCyclesId}", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.migratingVms.replicationCycles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReplicationCycle.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+/replicationCycles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "ReplicationCycle" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ReplicationCycles in a given MigratingVM.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles", + "httpMethod": "GET", + "id": "vmmigration.projects.locations.sources.migratingVms.replicationCycles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. the order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of replication cycles to return. The service may return fewer than this value. If unspecified, at most 100 migrating VMs will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Required. A page token, received from a previous `ListReplicationCycles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReplicationCycles` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of ReplicationCycles.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/migratingVms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/replicationCycles", + "response": { + "$ref": "ListReplicationCyclesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -1897,7 +1972,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AdaptingOSStep": { @@ -1960,7 +2035,7 @@ "Unspecified license for the OS.", "No license available for the OS.", "The license type is Pay As You Go license type.", - "The license type is is Bring Your Own License type." + "The license type is Bring Your Own License type." ], "type": "string" } @@ -2942,6 +3017,34 @@ }, "type": "object" }, + "ListReplicationCyclesResponse": { + "description": "Response message for 'ListReplicationCycles' request.", + "id": "ListReplicationCyclesResponse", + "properties": { + "nextPageToken": { + "description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "readOnly": true, + "type": "string" + }, + "replicationCycles": { + "description": "Output only. The list of replication cycles response.", + "items": { + "$ref": "ReplicationCycle" + }, + "readOnly": true, + "type": "array" + }, + "unreachable": { + "description": "Output only. Locations that could not be reached.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "ListSourcesResponse": { "description": "Response message for 'ListSources' request.", "id": "ListSourcesResponse", @@ -3431,11 +3534,20 @@ "description": "ReplicationCycle contains information about the current replication cycle status.", "id": "ReplicationCycle", "properties": { + "cycleNumber": { + "description": "The cycle's ordinal number.", + "format": "int32", + "type": "integer" + }, "endTime": { "description": "The time the replication cycle has ended.", "format": "google-datetime", "type": "string" }, + "error": { + "$ref": "Status", + "description": "Provides details on the state of the cycle in case of an error." + }, "name": { "description": "The identifier of the ReplicationCycle.", "type": "string" @@ -3455,6 +3567,24 @@ "format": "google-datetime", "type": "string" }, + "state": { + "description": "State of the MigratingVm.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "PAUSED", + "FAILED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "The state is unknown. This is used for API compatibility only and is not used by the system.", + "The replication cycle is running.", + "The replication cycle is paused.", + "The replication cycle finished with errors.", + "The replication cycle finished successfully." + ], + "type": "string" + }, "steps": { "description": "The cycle's steps list representing its progress.", "items": { diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index f272a3bf192..8cf414c30fd 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -452,7 +452,7 @@ } } }, - "revision": "20220826", + "revision": "20220910", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index c4db4fdb648..2af8d32332f 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -299,7 +299,7 @@ } } }, - "revision": "20220830", + "revision": "20220908", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "CancelExecutionRequest": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json index 916c5a1e803..7192f07734b 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json @@ -269,7 +269,7 @@ } } }, - "revision": "20220830", + "revision": "20220908", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "CancelExecutionRequest": { diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index af6bc4f1950..3c207b260ed 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -444,7 +444,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/workflows.v1beta.json b/googleapiclient/discovery_cache/documents/workflows.v1beta.json index 2b63465b8bd..804a4ebc86a 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json @@ -444,7 +444,7 @@ } } }, - "revision": "20220825", + "revision": "20220908", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 8c1666fc135..96b4191f51f 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -3829,7 +3829,7 @@ } } }, - "revision": "20220910", + "revision": "20220917", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { diff --git a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json index 38e02f5109b..c4d55338209 100644 --- a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +++ b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json @@ -421,7 +421,7 @@ } } }, - "revision": "20220904", + "revision": "20220916", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": { "EmptyResponse": { diff --git a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json index 052eb3db4bc..08d4c2f55c5 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20220904", + "revision": "20220917", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { From 16bfb49cbd25c32ddfd8d6370d6b69f106e477bd Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Tue, 20 Sep 2022 06:23:28 -0400 Subject: [PATCH 5/5] chore(main): release 2.62.0 (#1923) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- CHANGELOG.md | 24 ++++++++++++++++++++++++ googleapiclient/version.py | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3102133ee42..02776ffcf99 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,29 @@ # Changelog +## [2.62.0](https://github.com/googleapis/google-api-python-client/compare/v2.61.0...v2.62.0) (2022-09-20) + + +### Features + +* **analyticshub:** update the api https://github.com/googleapis/google-api-python-client/commit/2cedffbb22a6e35606a4bfe2a53659d7eb51a29b ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **artifactregistry:** update the api https://github.com/googleapis/google-api-python-client/commit/24238de0ec1217ab561bc2f2b036902a0a9dfdb3 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **assuredworkloads:** update the api https://github.com/googleapis/google-api-python-client/commit/997e916d31f872f46a547dbe01a7b934d78901a5 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **bigquery:** update the api https://github.com/googleapis/google-api-python-client/commit/92ed528e52437f31f847b8707d7771fb94601f02 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **chromemanagement:** update the api https://github.com/googleapis/google-api-python-client/commit/db416b5adeeb3798d51053d15954d4a9d4b2e742 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **chromepolicy:** update the api https://github.com/googleapis/google-api-python-client/commit/a7eed1e84355a854288c0e4641c99ac9dcb936f3 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **clouddeploy:** update the api https://github.com/googleapis/google-api-python-client/commit/70bd2645b516d85169c237d820c894f7c802f392 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **cloudsearch:** update the api https://github.com/googleapis/google-api-python-client/commit/73b68e5ead37d294ba141c07242e509c32b9117b ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **container:** update the api https://github.com/googleapis/google-api-python-client/commit/4fe448c2aca8c375f15a9cab6376d9ebcce24bc9 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **dataflow:** update the api https://github.com/googleapis/google-api-python-client/commit/6b5939f52dcea65745f975834ef15c50c3f138bf ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **dlp:** update the api https://github.com/googleapis/google-api-python-client/commit/34f565996691cfe1d9f7e9f591827814dbf892ef ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **documentai:** update the api https://github.com/googleapis/google-api-python-client/commit/29836a3a88e04b3504cea614522e931e5aa86ef7 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **gkehub:** update the api https://github.com/googleapis/google-api-python-client/commit/bf6630520fceb9690b9231f1e8fbeb03f1a6f29c ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **identitytoolkit:** update the api https://github.com/googleapis/google-api-python-client/commit/9ab1181d09b6bb7164a690c362a7a1087a5b2316 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **manufacturers:** update the api https://github.com/googleapis/google-api-python-client/commit/d1c509547d0578b1703016a0da377cb220f623fe ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **securitycenter:** update the api https://github.com/googleapis/google-api-python-client/commit/a92bfb1c384b7c54b4e7fc8c4b08ea09226e724b ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **spanner:** update the api https://github.com/googleapis/google-api-python-client/commit/25a029df4f27696c9e13b6955deb1f5f3161fc75 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) +* **vmmigration:** update the api https://github.com/googleapis/google-api-python-client/commit/62a1ccf9773b8de9ed9f582384d4f5182fd78104 ([4385b0d](https://github.com/googleapis/google-api-python-client/commit/4385b0db8af24676206727b2296d87bcc2decd95)) + ## [2.61.0](https://github.com/googleapis/google-api-python-client/compare/v2.60.0...v2.61.0) (2022-09-13) diff --git a/googleapiclient/version.py b/googleapiclient/version.py index 52ccde90983..c5bfc5d0265 100644 --- a/googleapiclient/version.py +++ b/googleapiclient/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "2.61.0" +__version__ = "2.62.0"